import { Item } from './gtag.js';
import { EventName, TrackName, TrackProperties } from './types.js';

type Content = {
    id: string;
    quantity: number;
    item_price?: number;
    title?: string;
    description?: string;
    brand?: string;
    category?: string;
    delivery_category?: string;
};
/**
 * reference: https://developers.facebook.com/docs/meta-pixel/advanced/advanced-matching
 * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters
 */
type MatchingParameters = {
    /** Email: Unhashed lowercase or hashed SHA-256 */
    em?: string;
    /** First Name: Lowercase letters */
    fn?: string;
    /** Last Name: Lowercase letters */
    ln?: string;
    /** Phone Number: Digits only including country code and area code */
    ph?: string;
    /**
     * External ID: Any unique ID from the advertiser, such as loyalty membership ID, user ID, and
     * external cookie ID.
     */
    external_id?: string;
    /** Gender: Single lowercase letter, f or m, if unknown, leave blank */
    ge?: 'f' | 'm' | '';
    /** Birthdate: Digits only with birth year, month, then day, YYYYMMDD */
    db?: number;
    /** City: Lowercase with any spaces removed, e.g. "menlopark" */
    ct?: string;
    /** State or Province: Lowercase two-letter state or province code, e.g. "ca" */
    st?: string;
    /** Zip or Postal Code: String */
    zp?: string;
    /** Country: Lowercase two-letter country code, e.g. "us" */
    country?: string;
    /** Client IP Address: Do not hash. */
    client_ip_address?: string;
    /** Client User Agent: Do not hash. */
    client_user_agent?: string;
    /**
     * Click ID: Do not hash.
     * The Facebook click ID value is stored in the _fbc browser cookie under your domain. See
     * Managing fbc and fbp Parameters for how to get this value or generate this value from a fbclid
     * query parameter.
     *
     * The format is fb.${subdomain_index}.${creation_time}.${fbclid}.
     */
    fbc?: string;
    /**
     * Browser ID: Do not hash.
     * The Facebook browser ID value is stored in the _fbp browser cookie under your domain. See
     * Managing fbc and fbp Parameters for how to get this value.
     *
     * The format is fb.${subdomain_index}.${creation_time}.${random_number}.
     */
    fbp?: string;
    /**
     * Subscription ID: Do not hash.
     * The subscription ID for the user in this transaction; it is similar to the order ID for an
     * individual product.
     */
    subscription_id?: string;
    /**
     * Facebook Login ID: Do not hash.
     * The ID issued by Meta when a person first logs into an instance of an app. This is also known
     * as App-Scoped ID.
     */
    fb_login_id?: number;
    /**
     * Lead ID: Do not hash.
     * The ID associated with a lead generated by [Meta's Lead Ads](https://developers.facebook.com/docs/marketing-api/guides/lead-ads).
     */
    lead_id?: number;
    /**
     * Install ID: Do not hash.
     * Your install ID. This field represents unique application installation instances.
     * Note: This parameter is for app events only.
     */
    anon_id?: string;
    /**
     * Your mobile advertiser ID, the advertising ID from an Android device or the Advertising
     * Identifier (IDFA) from an Apple device.
     */
    madid?: string;
    /**
     * Page ID: Do not hash.
     * Your Page ID. Specifies the page ID associated with the event. Use the Facebook page ID of the
     * page associated with the bot.
     */
    page_id?: string;
    /**
     * Page Scoped User ID: Do not hash.
     * Specifies the page-scoped user ID associated with the messenger bot that logs the event. Use
     * the page-scoped user ID provided to your webhook.
     */
    page_scoped_user_id?: string;
    /**
     * Do not hash.
     * Click ID generated by Meta for ads that click to WhatsApp.
     */
    ctwa_clid?: string;
    /**
     * Do not hash.
     * Instagram Account ID that is associated with the business.
     */
    ig_account_id?: string;
    /**
     * Do not hash.
     * Users who interact with Instagram are identified by Instagram-Scoped User IDs (IGSID). IGSID
     * can be obtained from this webhook.
     */
    ig_sid?: string;
};
/**
 * You can include the following predefined object properties with any custom events, and any
 * standard events that support them. Format your parameter object data using JSON. Learn more about
 * event parameters with Blueprint.
 */
type ObjectProperties = {
    content_category?: string;
    content_ids?: string[];
    content_name?: string;
    /**
     * Either product or product_group based on the content_ids or contents being passed. If the IDs
     * being passed in content_ids or contents parameter are IDs of products, then the value should be
     * product. If product group IDs are being passed, then the value should be product_group.
     *
     * If no content_type is provided, Meta will match the event to every item that has the same ID,
     * independent of its type.
     */
    content_type?: 'product' | 'product_group' | (string & {});
    contents?: Content[];
    delivery_category?: 'in_store' | 'curbside' | 'home_delivery';
    currency?: string;
    num_items?: number;
    predicted_ltv?: number;
    search_string?: string;
    /** Used with the CompleteRegistration event, to show the status of the registration. */
    status?: boolean;
    value?: number;
};
/**
 * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/payload-helper
 */
type StandardEvents = {
    AddPaymentInfo: {
        content_ids?: string[];
        contents?: Content[];
        currency?: string;
        value?: number;
    };
    AddToCart: {
        content_ids?: string[];
        content_type?: string;
        contents?: Content[];
        currency?: string;
        value?: number;
    };
    AddToWishlist: {
        content_ids?: string[];
        contents?: Content[];
        currency?: string;
        value?: number;
    };
    CompleteRegistration: {
        currency?: string;
        value?: number;
        method?: string;
    };
    Contact: {};
    CustomizeProduct: {};
    Donate: {};
    FindLocation: {};
    InitiateCheckout: {
        content_ids?: string[];
        contents?: Content[];
        currency?: string;
        num_items?: number;
        value?: number;
    };
    Lead: {
        currency?: string;
        value?: number;
    };
    Purchase: {
        content_ids?: string[];
        content_type?: string;
        contents?: Content[];
        currency: string;
        num_items?: number;
        value: number;
    };
    Schedule: {};
    Search: {
        content_ids?: string[];
        content_type?: string;
        contents?: Content[];
        currency?: string;
        search_string?: string;
        value?: number;
    };
    StartTrial: {
        currency?: string;
        predicted_ltv?: number;
        value?: number;
    };
    SubmitApplication: {};
    Subscribe: {
        currency?: string;
        predicted_ltv?: number;
        value?: number;
    };
    ViewContent: {
        content_ids?: string[];
        content_type?: string;
        contents?: Content[];
        currency?: string;
        value?: number;
    };
};
type JSONValue = null | string | number | boolean | Array<JSONValue> | {
    [value: string]: JSONValue;
};
type PixelId = `${number}`;
type Options = {
    eventID?: string;
};
/**
 * reference: https://developers.facebook.com/docs/meta-pixel/reference#standard-events
 *
 * We determine if events are identical based on their ID and name. So, for an event to be deduplicated:
 * - In corresponding events, a Meta Pixel's eventID must match the Conversion API's event_id.
 * - In corresponding events, a Meta Pixel's event must match the Conversion API's event_name.
 *
 * reference: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters
 */
interface FBQ {
    /**
     * reference: https://stackoverflow.com/questions/62304291/sending-user-data-parameters-via-pixel
     *
     * Call init the normal default way first:
     * `fbq('init', 'XXXXX')`
     *
     * And at a later point in time, when you have obtained additional user data, you can call init
     * again basically enriching the already running fbq instance with additional data:
     * `fbq('init', 'XXXXX', { external_id: 1234, em: 'abc@abc.com' } )`
     *
     * Only caveat is that you have to send an event after this additional init call, otherwise the
     * provided data will not be sent to Facebook.
     */
    fbq(type: 'init', pixelId: PixelId, parameters?: MatchingParameters): void;
    /** Enable Manual Only mode. (value = false) */
    fbq(type: 'set', key: 'autoConfig', value: boolean, pixelId: PixelId): void;
    fbq<T extends keyof StandardEvents>(type: 'track', event: T, properties?: StandardEvents[T] & ObjectProperties, options?: Options): void;
    fbq(type: 'trackCustom', event: string, properties?: Record<string, JSONValue> & ObjectProperties, options?: Options): void;
    /** https://developers.facebook.com/docs/meta-pixel/guides/track-multiple-events/ */
    fbq<T extends keyof StandardEvents>(type: 'trackSingle', pixelId: PixelId, event: T, properties?: StandardEvents[T] & ObjectProperties, options?: Options): void;
    /** https://developers.facebook.com/docs/meta-pixel/guides/track-multiple-events/ */
    fbq(type: 'trackSingleCustom', pixelId: PixelId, event: string, properties?: Record<string, JSONValue> & ObjectProperties, options?: Options): void;
}
/**
 * Please download this CSV filefor examples of properly normalized and hashed data for the
 * parameters below.
 */
declare function normalize(parameters: MatchingParameters): MatchingParameters;
declare function mapItems(items?: Item[]): ObjectProperties;
type Mapped<F extends keyof StandardEvents> = ['track', F, StandardEvents[F] & ObjectProperties];
type Missed<F extends string> = ['trackCustom', F, Record<string, JSONValue> & ObjectProperties];
declare function mapFBEvent<T extends EventName>(name: TrackName<T>, properties?: TrackProperties<T>): Mapped<keyof StandardEvents> | Missed<TrackName<T>>;

export { type Content, type FBQ, type MatchingParameters, type ObjectProperties, type Options, type PixelId, type StandardEvents, mapFBEvent, mapItems, normalize };