@artisan-commerce/analytics-web 0.2.0-canary.78 → 0.2.0-canary.8

package/build/src/lib/events/vendor/setVendor/setVendor.types.d.ts

@@ -0,0 +1,23 @@
+import { Vendor } from "@artisan-commerce/types";
+import { SetVendorParams as GoogleSetVendorParams } from "../../../providers/GoogleAnalytics/events/vendor/setVendor/setVendor.types";
+import { SetVendorParams as FacebookSetVendorParams } from "../../../providers/FacebookPixel/events/vendor/setVendor/setVendor.types";
+import { SetVendorParams as SegmentSetVendorParams } from "../../../providers/Segment/events/vendor/setVendor/setVendor.types";
+/**
+ * setVendor event interface.
+ *
+ * @interface SetVendorCommonParams
+ * @since 0.5.14
+ * @property {number} vendorId The new set vendor identifier
+ * @property {string} vendorName The new set vendor name
+ */
+export interface SetVendorCommonParams {
+    vendorId: Vendor["id"];
+    vendorName?: Vendor["name"];
+}
+/**
+ * setVendor event params.
+ *
+ * @typedef SetVendorParams
+ * @since 0.5.14
+ */
+export declare type SetVendorParams = GoogleSetVendorParams & FacebookSetVendorParams & SegmentSetVendorParams;

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

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

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

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

package/build/src/lib/events/workflow/selectWorkflow/selectWorkflow.d.ts

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

package/build/src/lib/events/workflow/selectWorkflow/selectWorkflow.test.d.ts

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

package/build/src/lib/events/workflow/selectWorkflow/selectWorkflow.types.d.ts

@@ -0,0 +1,21 @@
+import { SelectWorkflowParams as GoogleSelectWorkflowParams } from "../../../providers/GoogleAnalytics/events/workflow/selectWorkflow/selectWorkflow.types";
+import { SelectWorkflowParams as FacebookSelectWorkflowParams } from "../../../providers/FacebookPixel/events/workflow/selectWorkflow/selectWorkflow.types";
+import { SelectWorkflowParams as SegmentSelectWorkflowParams } from "../../../providers/Segment/events/workflow/selectWorkflow/selectWorkflow.types";
+import { Workflow } from "../../events.types";
+/**
+ * selectWorkflow event interface.
+ *
+ * @interface SelectWorkflowCommonParams
+ * @since 0.5.14
+ * @property {Workflow} workflow The workflow name (e.g. Delivery)
+ */
+export interface SelectWorkflowCommonParams {
+    workflow: Workflow;
+}
+/**
+ * selectWorkflow event params.
+ *
+ * @typedef SelectWorkflowParams
+ * @since 0.5.14
+ */
+export declare type SelectWorkflowParams = GoogleSelectWorkflowParams & FacebookSelectWorkflowParams & SegmentSelectWorkflowParams;

package/build/src/lib/events/workflow/updateWorkflow/updateWorkflow.d.ts

@@ -0,0 +1,11 @@
+import { UpdateWorkflowParams } from "./updateWorkflow.types";
+/**
+ * Emits a UpdateWorkflow event to every configured provider.
+ *
+ * Log this event when the workflow has changed.
+ *
+ * @since 0.5.14
+ * @property {UpdateWorkflowParams} params UpdateWorkflow event parameters
+ */
+declare const logUpdateWorkflow: (params: UpdateWorkflowParams) => void;
+export default logUpdateWorkflow;

package/build/src/lib/events/workflow/updateWorkflow/updateWorkflow.test.d.ts

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

package/build/src/lib/events/workflow/updateWorkflow/updateWorkflow.types.d.ts

@@ -0,0 +1,23 @@
+import { UpdateWorkflowParams as GoogleUpdateWorkflowParams } from "../../../providers/GoogleAnalytics/events/workflow/updateWorkflow/updateWorkflow.types";
+import { UpdateWorkflowParams as FacebookUpdateWorkflowParams } from "../../../providers/FacebookPixel/events/workflow/updateWorkflow/updateWorkflow.types";
+import { UpdateWorkflowParams as SegmentUpdateWorkflowParams } from "../../../providers/Segment/events/workflow/updateWorkflow/updateWorkflow.types";
+import { Workflow } from "../../events.types";
+/**
+ * updateWorkflow event interface.
+ *
+ * @interface UpdateWorkflowCommonParams
+ * @since 0.5.14
+ * @property {Workflow} previousWorkflow The previous selected workflow name (e.g. Delivery)
+ * @property {Workflow} nextWorkflow The next workflow name (e.g. Delivery)
+ */
+export interface UpdateWorkflowCommonParams {
+    previousWorkflow: Workflow;
+    nextWorkflow: Workflow;
+}
+/**
+ * updateWorkflow event params.
+ *
+ * @typedef UpdateWorkflowParams
+ * @since 0.5.14
+ */
+export declare type UpdateWorkflowParams = GoogleUpdateWorkflowParams & FacebookUpdateWorkflowParams & SegmentUpdateWorkflowParams;

package/build/src/lib/initAnalytics/initAnalytics.d.ts

@@ -0,0 +1,8 @@
+import { InitAnalyticsConfig } from "./initAnalytics.types";
+/**
+ * Initializes the analytics module, connects to every provider.
+ *
+ * @since 0.5.14
+ * @param {InitAnalyticsConfig} config Initialization configuration.
+ */
+export declare const initAnalytics: (config: InitAnalyticsConfig) => void;

package/build/src/lib/initAnalytics/initAnalytics.helpers.d.ts

@@ -0,0 +1,17 @@
+import { AnalyticsProviderTypes } from "../../types/event.types";
+/**
+ * Check if the given providers names are unique.
+ *
+ * @since 0.5.14
+ * @param {AnalyticsProviderTypes[]} providers Providers list
+ * @returns {boolean} true if no provider names clashes with another
+ */
+export declare const checkUniqueProviderNames: (providers: AnalyticsProviderTypes[]) => boolean;
+/**
+ * Check if the given providers tracker ids are unique.
+ *
+ * @since 0.5.14
+ * @param {AnalyticsProviderTypes[]} providers Providers list
+ * @returns {boolean} true if no provider trackerId clashes with another
+ */
+export declare const checkUniqueProviderTrackerIds: (providers: AnalyticsProviderTypes[]) => boolean;

package/build/src/lib/initAnalytics/initAnalytics.test.d.ts

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

package/build/src/lib/initAnalytics/initAnalytics.types.d.ts

@@ -0,0 +1,44 @@
+import { Vendor } from "@artisan-commerce/types";
+import { AnalyticsMeta } from "../../types/common.types";
+import { AnalyticsProviderTypes } from "../../types/event.types";
+/**
+ * Initial configuration that can be passed to initAnalytics method.
+ *
+ * @interface InitAnalyticsConfig
+ * @since 0.5.14
+ * @property {AnalyticsProviderTypes[]} providers Analytics providers instances that can be targeted to emit events
+ * @property {number} activeVendor The vendor that will emit the events
+ * @property {number[]|undefined} vendors List of vendors that can emit events if active
+ * @property {boolean} debug Debug mode
+ * @property {boolean} shareArtisnAnalytics Share e-commerce analytics with Trade
+ * @property {InitAnalyticsConfigMeta} meta Commerce's metadata
+ */
+export interface InitAnalyticsConfig {
+    providers: AnalyticsProviderTypes[];
+    activeVendor?: Vendor["id"];
+    vendors: Vendor["id"][] | undefined;
+    debug?: boolean;
+    shareArtisnAnalytics?: boolean;
+    meta: InitAnalyticsConfigMeta;
+}
+/**
+ * Commerce's metadata
+ *
+ * @interface InitAnalyticsConfigMeta
+ * @since 0.5.14
+ * @extends AnalyticsMeta
+ * @property {string} vendorName The name of the active vendor
+ * @property {number} storeId The id of the active store
+ * @property {string} storeName The name of the active store
+ * @property {number} catalogueId The id of the active catalogue
+ * @property {string} catalogueName The name of the active catalogue
+ * @property {ArtisnPlatform} platform The type of platform it is running on
+ */
+export interface InitAnalyticsConfigMeta extends Omit<AnalyticsMeta, "vendorId" | "versionSDK" | "platform" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName"> {
+    vendorName?: AnalyticsMeta["vendorName"] | undefined;
+    storeId?: AnalyticsMeta["storeId"] | undefined;
+    storeName?: AnalyticsMeta["storeName"] | undefined;
+    catalogueId?: AnalyticsMeta["catalogueId"] | undefined;
+    catalogueName?: AnalyticsMeta["catalogueName"] | undefined;
+    platform?: AnalyticsMeta["platform"] | undefined;
+}

package/build/src/lib/providers/AnalyticsProvider/AnalyticsProvider.d.ts

@@ -0,0 +1,44 @@
+import { AnalyticsProviderConstructor as Config } from "./AnalyticsProvider.types";
+import { IAnaliticsProvider } from "./AnalyticsProvider.types";
+/**
+ * Represents the base properties all AnalyticsProviders have.
+ *
+ * @abstract
+ * @since 0.5.14
+ */
+declare abstract class AnalyticsProvider implements IAnaliticsProvider {
+    private initialized;
+    readonly type: Config["type"];
+    readonly name: Config["name"];
+    readonly trackingId: Config["trackingId"];
+    private readonly _vendors;
+    /**
+     * Representation of a Customer Account
+     *
+     * @constructs
+     * @since 0.5.14
+     * @param {Config} config artisn's account unique identifier.
+     */
+    constructor(config: Config);
+    /**
+     * Gets the allowed vendors of the Analytics Provider.
+     *
+     * @since 0.5.14
+     * @returns Analytics Provider vendors, if not specified it fallsback to the global vendors
+     */
+    get vendors(): number[] | undefined;
+    /**
+     * Inserts the initialization script to the body of the document.
+     *
+     * @since 0.5.14
+     */
+    init(): void;
+    /**
+     * Updates the provider instance config for the next events.
+     *
+     * @since 0.5.14
+     * @param {Partial<unknown>} config Analyticis provider configurable options
+     */
+    updateConfig(config: Partial<unknown>): void;
+}
+export default AnalyticsProvider;

package/build/src/lib/providers/AnalyticsProvider/AnalyticsProvider.test.d.ts

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

package/build/src/lib/providers/AnalyticsProvider/AnalyticsProvider.types.d.ts

@@ -0,0 +1,32 @@
+import { Vendor } from "@artisan-commerce/types";
+import { SupportedProviders } from "../../../types/common.types";
+/**
+ * Analytics Provider base intance config.
+ *
+ * @interface AnalyticsProviderConstructor
+ * @since 0.5.14
+ * @property {SupportedProviders} type Type of analytics provider
+ * @property {string} name Analytics provider name
+ * @property {string} trackingId Analytics provider tracking id
+ * @property {number[]} vendors List of vendors that can emit this provider events if active (defaults to all vendors)
+ */
+export interface AnalyticsProviderConstructor {
+    type: SupportedProviders;
+    name: string;
+    trackingId: string;
+    vendors?: Vendor["id"][];
+}
+/**
+ * AnalyticsProvider Class interface.
+ *
+ * @interface IAnaliticsProvider
+ * @since 0.5.14
+ * @property {Function} init Initializes the provider connection
+ * @property {Function} updateConfig Updates the initial config of the provider
+ * @property {number[]} vendors The provider selected vendors ids
+ */
+export interface IAnaliticsProvider {
+    init: () => void;
+    updateConfig: (config: Partial<unknown>) => void;
+    vendors: Vendor["id"][] | undefined;
+}

package/build/src/lib/providers/FacebookPixel/FacebookPixel.d.ts

@@ -0,0 +1,35 @@
+import AnalyticsProvider from "../AnalyticsProvider/AnalyticsProvider";
+import { FacebookPixelProvider as Config } from "./FacebookPixel.types";
+import { FacebookPixelProviderConfig } from "./FacebookPixel.types";
+/**
+ * Create a Facebook Pixel provider instance.
+ *
+ * @class
+ * @since 0.5.14
+ * @extends AnalyticsProvider
+ */
+declare class FacebookPixel extends AnalyticsProvider {
+    private readonly _version;
+    private _currency;
+    /**
+     * Contructs a Facebook Pixel Provider
+     *
+     * @constructs
+     * @since 0.5.14
+     * @param {Config} config provider configuration
+     */
+    constructor(config: Config);
+    get version(): Config["version"];
+    get currency(): Config["currency"];
+    /**
+     * @override
+     * @since 0.5.14
+     */
+    init(): void;
+    /**
+     * @override
+     * @since 0.5.14
+     */
+    updateConfig(config?: Partial<FacebookPixelProviderConfig>): void;
+}
+export default FacebookPixel;

package/build/src/lib/providers/FacebookPixel/FacebookPixel.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/FacebookPixel.types.d.ts

@@ -0,0 +1,58 @@
+import { CurrencyCodes } from "@artisan-commerce/types";
+import { EventCommonParams } from "../../../types/event.types";
+import { AnalyticsProviderConstructor } from "../AnalyticsProvider/AnalyticsProvider.types";
+/**
+ * Facebook Pixel Provider constructor configuration.
+ *
+ * @interface FacebookPixelProvider
+ * @since 0.5.14
+ * @implements AnalyticsProviderConstructor, FacebookPixelProviderConfig
+ * @property {string} version Facebook Pixel SDK version
+ */
+export interface FacebookPixelProvider extends Omit<AnalyticsProviderConstructor, "type">, FacebookPixelProviderConfig {
+    version?: string;
+}
+/**
+ * Facebook Pixel Provider after instantiated configurable options.
+ *
+ * @interface FacebookPixelProvider
+ * @since 0.5.14
+ * @property {CurrencyCodes} currency user's country monetary code
+ */
+export interface FacebookPixelProviderConfig {
+    currency?: CurrencyCodes;
+}
+/**
+ * Facebook Pixel event shared parameters.
+ *
+ * @interface FacebookPixelCommonEventParams
+ * @since 0.5.14
+ * @extends EventCommonParams
+ */
+export interface FacebookPixelCommonEventParams extends EventCommonParams {
+}
+/**
+ * Facebook Pixel custom event shared parameters.
+ *
+ * @interface FacebookPixelCustomEventParams
+ * @since 0.5.14
+ */
+export interface FacebookPixelCustomEventParams {
+    [key: string]: any;
+}
+export declare namespace Fbq {
+    interface Fbq {
+        (command: "trackSingle", targetId: string, eventName: EventNames, eventParams?: ControlParams | EventParams | CustomParams): void;
+        (command: "trackSingleCustom", targetId: string, eventName: string, eventParams?: ControlParams | EventParams | CustomParams): void;
+    }
+    interface CustomParams {
+        [key: string]: any;
+    }
+    interface ControlParams {
+    }
+    type EventNames = "PageView" | "CompleteRegistration" | "FindLocation" | "Search" | "CustomizeProduct" | "InitiateCheckout" | "AddPaymentInfo" | "Schedule" | "Purchase" | "Lead" | "AddToCart" | "AddToWishlist" | "Contact" | "ViewContent" | "SpendCredits";
+    interface EventParams {
+        currency?: string;
+        value?: number;
+    }
+}

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordAttempt/changePasswordAttempt.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordAttempt/changePasswordAttempt.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordAttempt/changePasswordAttempt.types.d.ts

@@ -0,0 +1,14 @@
+import { ChangePasswordAttemptCommonParams } from "../../../../../events/auth/changePasswordAttempt/changePasswordAttempt.types";
+import { FacebookPixelCommonEventParams } from "../../../../FacebookPixel/FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../../FacebookPixel/FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ChangePasswordAttemptParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends ChangePasswordAttemptCommonParams
+ */
+export interface ChangePasswordAttemptParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ChangePasswordAttemptCommonParams {
+}

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordFail/changePasswordFail.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordFail/changePasswordFail.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordFail/changePasswordFail.types.d.ts

@@ -0,0 +1,14 @@
+import { ChangePasswordFailCommonParams } from "../../../../../events/auth/changePasswordFail/changePasswordFail.types";
+import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ChangePasswordFailParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends ChangePasswordFailCommonParams
+ */
+export interface ChangePasswordFailParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ChangePasswordFailCommonParams {
+}

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordSuccess/changePasswordSuccess.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordSuccess/changePasswordSuccess.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/changePasswordSuccess/changePasswordSuccess.types.d.ts

@@ -0,0 +1,14 @@
+import { ChangePasswordSuccessCommonParams } from "../../../../../events/auth/changePasswordSuccess/changePasswordSuccess.types";
+import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ChangePasswordSuccessParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends ChangePasswordSuccessCommonParams
+ */
+export interface ChangePasswordSuccessParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ChangePasswordSuccessCommonParams {
+}

package/build/src/lib/providers/FacebookPixel/events/auth/index.d.ts

@@ -0,0 +1,10 @@
+declare const events: {
+    changePasswordAttempt: (provider: import("../../FacebookPixel.types").FacebookPixelProvider, params: import("./changePasswordAttempt/changePasswordAttempt.types").ChangePasswordAttemptParams) => void;
+    signUpAttempt: (provider: import("../../FacebookPixel.types").FacebookPixelProvider, params: import("./signUpAttempt/signUpAttempt.types").SignUpAttemptParams) => void;
+    changePasswordFail: (provider: import("../../FacebookPixel.types").FacebookPixelProvider, params: import("./changePasswordFail/changePasswordFail.types").ChangePasswordFailParams) => void;
+    changePasswordSuccess: (provider: import("../../FacebookPixel.types").FacebookPixelProvider, params: import("./changePasswordSuccess/changePasswordSuccess.types").ChangePasswordSuccessParams) => void;
+    signIn: (provider: import("../../FacebookPixel.types").FacebookPixelProvider, params: import("./signIn/signIn.types").SignInParams) => void;
+    signOut: (provider: import("../../FacebookPixel.types").FacebookPixelProvider, params: import("./signOut/signOut.types").SignOutParams) => void;
+    signUp: (provider: import("../../FacebookPixel.types").FacebookPixelProvider, params: import("./signUp/signUp.types").SignUpParams) => void;
+};
+export default events;

package/build/src/lib/providers/FacebookPixel/events/auth/index.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signIn/signIn.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signIn/signIn.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signIn/signIn.types.d.ts

@@ -0,0 +1,14 @@
+import { SignInCommonParams } from "../../../../../events/auth/signIn/signIn.types";
+import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SignInParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends SignInCommonParams
+ */
+export interface SignInParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, SignInCommonParams {
+}

package/build/src/lib/providers/FacebookPixel/events/auth/signOut/signOut.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signOut/signOut.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signOut/signOut.types.d.ts

@@ -0,0 +1,14 @@
+import { SignOutCommonParams } from "../../../../../events/auth/signOut/signOut.types";
+import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SignOutParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends SignOutCommonParams
+ */
+export interface SignOutParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, SignOutCommonParams {
+}

package/build/src/lib/providers/FacebookPixel/events/auth/signUp/signUp.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signUp/signUp.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signUp/signUp.types.d.ts

@@ -0,0 +1,14 @@
+import { SignUpCommonParams } from "../../../../../events/auth/signUp/signUp.types";
+import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SignUpParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends SignUpCommonParams
+ */
+export interface SignUpParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, SignUpCommonParams {
+}

package/build/src/lib/providers/FacebookPixel/events/auth/signUpAttempt/signUpAttempt.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signUpAttempt/signUpAttempt.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/auth/signUpAttempt/signUpAttempt.types.d.ts

@@ -0,0 +1,14 @@
+import { SignUpAttemptCommonParams } from "../../../../../events/auth/signUpAttempt/signUpAttempt.types";
+import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SignUpAttemptParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends SignUpAttemptCommonParams
+ */
+export interface SignUpAttemptParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, SignUpAttemptCommonParams {
+}

package/build/src/lib/providers/FacebookPixel/events/banner/bannerImpression/bannerImpression.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/banner/bannerImpression/bannerImpression.test.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/banner/bannerImpression/bannerImpression.types.d.ts

@@ -0,0 +1,14 @@
+import { BannerImpressionCommonParams } from "../../../../../events/banner/bannerImpression/bannerImpression.types";
+import { FacebookPixelCommonEventParams } from "../../../FacebookPixel.types";
+import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface BannerImpressionParams
+ * @since 0.5.14
+ * @extends FacebookPixelCommonEventParams
+ * @extends FacebookPixelCustomEventParams
+ * @extends BannerImpressionCommonParams
+ */
+export interface BannerImpressionParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, BannerImpressionCommonParams {
+}