@shware/analytics 0.1.15 → 0.1.17

package/dist/types/index.d.cts

@@ -0,0 +1,327 @@
+interface Item {
+    item_brand?: string;
+    item_id?: string;
+    item_name?: string;
+    item_category?: string;
+    item_category2?: string;
+    item_category3?: string;
+    item_category4?: string;
+    item_category5?: string;
+    item_list_id?: string;
+    item_list_name?: string;
+    item_location_id?: string;
+    item_variant?: string;
+    quantity?: number;
+    price?: number;
+}
+/**
+ * ref: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag
+ * ref: https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event
+ * */
+type StandardEventProperties = {
+    add_payment_info: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        payment_type?: string;
+    };
+    add_shipping_info: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        shipping_tier?: string;
+    };
+    add_to_cart: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    add_to_wishlist: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    begin_checkout: {
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        items?: Item[];
+        [key: string]: any;
+    };
+    close_convert_lead: {
+        currency: string;
+        value: number;
+    };
+    close_unconvert_lead: {
+        currency: string;
+        value: number;
+        unconvert_lead_reason?: string;
+    };
+    disqualify_lead: {
+        currency: string;
+        value: number;
+        disqualified_lead_reason?: string;
+    };
+    earn_virtual_currency: {
+        virtual_currency_name: string;
+        value: number;
+    };
+    generate_lead: {
+        currency?: string;
+        value?: number;
+    };
+    join_group: {
+        group_id: string;
+    };
+    level_end: {
+        level: number;
+        success?: string;
+    };
+    level_start: {
+        level: number;
+    };
+    level_up: {
+        level: number;
+        character?: string;
+    };
+    login: {
+        method: string;
+    };
+    post_score: {
+        score: number;
+        level?: number;
+        character?: string;
+    };
+    purchase: {
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        items?: Item[];
+        shipping?: number;
+        tax?: number;
+        value?: number;
+        transaction_id?: string;
+        [key: string]: any;
+    };
+    qualify_lead: {
+        currency: string;
+        value: number;
+    };
+    refund: {
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        items?: Item[];
+        shipping?: number;
+        tax?: number;
+        value?: number;
+        transaction_id?: string;
+    };
+    remove_from_cart: {
+        items?: Item[];
+        value?: number;
+        currency?: string;
+    };
+    search: {
+        search_term: string;
+        number_of_nights?: number;
+        number_of_rooms?: number;
+        number_of_passengers?: number;
+        origin?: string;
+        destination?: string;
+        start_date?: string;
+        end_date?: string;
+        travel_class?: string;
+    };
+    select_content: {
+        content_type: string;
+        item_id: string;
+    };
+    select_item: {
+        items?: Item[];
+        content_type: string;
+        item_list_id: string;
+        item_list_name: string;
+    };
+    select_promotion: {
+        creative_name: string;
+        creative_slot: string;
+        items?: Item[];
+        location_id: string;
+        promotion_id: string;
+        promotion_name: string;
+    };
+    share: {
+        content_type: string;
+        item_id: string;
+        method: string;
+        activity_type?: string | null;
+        post_id?: string;
+    };
+    sign_up: {
+        method: string;
+    };
+    spend_virtual_currency: {
+        item_name: string;
+        virtual_currency_name: string;
+        value: number;
+    };
+    tutorial_begin: undefined;
+    tutorial_complete: undefined;
+    unlock_achievement: {
+        achievement_id: string;
+    };
+    view_cart: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    view_item: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    view_item_list: {
+        items?: Item[];
+        item_list_id?: string;
+        item_list_name?: string;
+    };
+    view_promotion: {
+        items?: Item[];
+        location_id?: string;
+        creative_name?: string;
+        creative_slot?: string;
+        promotion_id?: string;
+        promotion_name?: string;
+    };
+    working_lead: {
+        currency: string;
+        value: number;
+        lead_status?: string;
+    };
+    ad_impression: {
+        value?: number;
+        currency?: string;
+        ad_format?: string;
+        ad_platform?: string;
+        ad_source?: string;
+        ad_unit_name?: string;
+    };
+    app_open: undefined;
+    campaign_details: {
+        source: string;
+        medium: string;
+        campaign: string;
+        term?: string;
+        content?: string;
+        aclid?: string;
+        cp1?: string;
+    };
+    screen_view: {
+        screen_name?: string;
+        screen_class?: string;
+    };
+    view_search_results: {
+        search_term: string;
+    };
+};
+type AllowedPropertyValues = string | number | boolean | null;
+type EventName = Lowercase<string>;
+type CustomEventProperties = Record<Lowercase<string>, AllowedPropertyValues>;
+type TrackProperties<T extends EventName = EventName> = T extends keyof StandardEventProperties ? StandardEventProperties[T] : CustomEventProperties;
+interface UserData {
+    userId: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    dateOfBirth?: string;
+    gender?: string;
+    city?: string;
+    state?: string;
+    postal?: string;
+    country?: string;
+}
+type ThirdPartyTracker = <T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, event_id?: string) => void;
+interface PlatformInfo {
+    os?: string;
+    os_name?: string;
+    os_version?: string;
+    browser?: string;
+    browser_name?: string;
+    browser_version?: string;
+    platform?: 'ios' | 'android' | 'web' | 'macos' | 'windows' | 'linux' | 'unknown';
+}
+interface DeviceInfo {
+    device?: string;
+    device_id?: string;
+    device_type?: string;
+    device_vendor?: string;
+    device_pixel_ratio?: string;
+    screen_resolution?: `${number}x${number}`;
+}
+interface EnvironmentInfo {
+    release?: string;
+    language?: string;
+    timezone?: string;
+    environment?: 'development' | 'production';
+}
+interface SourceInfo {
+    source_url?: string;
+    source?: 'app' | 'web' | 'offline';
+}
+interface ThirdPartyFields {
+    /**
+     * Meta pixel fields
+     * ref: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters#fbc
+     * Stored in the _fbc/_fbp browser cookie under your domain
+     */
+    fbc?: string;
+    fbp?: string;
+    /**
+     * Google Analytics fields
+     */
+    gclid?: string;
+}
+interface UTMParams {
+    utm_source?: string;
+    utm_medium?: string;
+    utm_campaign?: string;
+    utm_term?: string;
+    utm_content?: string;
+}
+interface TrackTags extends PlatformInfo, DeviceInfo, EnvironmentInfo, SourceInfo, ThirdPartyFields, UTMParams {
+    [key: string]: string | undefined;
+}
+interface CreateTrackEventDTO<T extends EventName = EventName> {
+    name: string;
+    tags: TrackTags;
+    visitor_id: string;
+    properties?: TrackProperties<T>;
+    timestamp: string;
+}
+interface TrackEventResponse {
+    /**
+     * track event id
+     * some tracking system will use event_id and event_name for deduplication
+     * */
+    id: string;
+}
+type VisitorProperties = Record<Lowercase<string>, AllowedPropertyValues>;
+interface Visitor {
+    id: string;
+    device_id: string;
+    properties: VisitorProperties;
+}
+interface CreateVisitorDTO {
+    device_id: string;
+    properties?: VisitorProperties;
+}
+interface UpdateVisitorDTO {
+    properties: VisitorProperties;
+}
+type ThirdPartyUserSetter = (properties: VisitorProperties) => void;
+
+export type { AllowedPropertyValues, CreateTrackEventDTO, CreateVisitorDTO, CustomEventProperties, DeviceInfo, EnvironmentInfo, EventName, Item, PlatformInfo, SourceInfo, StandardEventProperties, ThirdPartyFields, ThirdPartyTracker, ThirdPartyUserSetter, TrackEventResponse, TrackProperties, TrackTags, UTMParams, UpdateVisitorDTO, UserData, Visitor, VisitorProperties };

package/dist/types/index.d.ts

@@ -0,0 +1,327 @@
+interface Item {
+    item_brand?: string;
+    item_id?: string;
+    item_name?: string;
+    item_category?: string;
+    item_category2?: string;
+    item_category3?: string;
+    item_category4?: string;
+    item_category5?: string;
+    item_list_id?: string;
+    item_list_name?: string;
+    item_location_id?: string;
+    item_variant?: string;
+    quantity?: number;
+    price?: number;
+}
+/**
+ * ref: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag
+ * ref: https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event
+ * */
+type StandardEventProperties = {
+    add_payment_info: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        payment_type?: string;
+    };
+    add_shipping_info: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        shipping_tier?: string;
+    };
+    add_to_cart: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    add_to_wishlist: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    begin_checkout: {
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        items?: Item[];
+        [key: string]: any;
+    };
+    close_convert_lead: {
+        currency: string;
+        value: number;
+    };
+    close_unconvert_lead: {
+        currency: string;
+        value: number;
+        unconvert_lead_reason?: string;
+    };
+    disqualify_lead: {
+        currency: string;
+        value: number;
+        disqualified_lead_reason?: string;
+    };
+    earn_virtual_currency: {
+        virtual_currency_name: string;
+        value: number;
+    };
+    generate_lead: {
+        currency?: string;
+        value?: number;
+    };
+    join_group: {
+        group_id: string;
+    };
+    level_end: {
+        level: number;
+        success?: string;
+    };
+    level_start: {
+        level: number;
+    };
+    level_up: {
+        level: number;
+        character?: string;
+    };
+    login: {
+        method: string;
+    };
+    post_score: {
+        score: number;
+        level?: number;
+        character?: string;
+    };
+    purchase: {
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        items?: Item[];
+        shipping?: number;
+        tax?: number;
+        value?: number;
+        transaction_id?: string;
+        [key: string]: any;
+    };
+    qualify_lead: {
+        currency: string;
+        value: number;
+    };
+    refund: {
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        items?: Item[];
+        shipping?: number;
+        tax?: number;
+        value?: number;
+        transaction_id?: string;
+    };
+    remove_from_cart: {
+        items?: Item[];
+        value?: number;
+        currency?: string;
+    };
+    search: {
+        search_term: string;
+        number_of_nights?: number;
+        number_of_rooms?: number;
+        number_of_passengers?: number;
+        origin?: string;
+        destination?: string;
+        start_date?: string;
+        end_date?: string;
+        travel_class?: string;
+    };
+    select_content: {
+        content_type: string;
+        item_id: string;
+    };
+    select_item: {
+        items?: Item[];
+        content_type: string;
+        item_list_id: string;
+        item_list_name: string;
+    };
+    select_promotion: {
+        creative_name: string;
+        creative_slot: string;
+        items?: Item[];
+        location_id: string;
+        promotion_id: string;
+        promotion_name: string;
+    };
+    share: {
+        content_type: string;
+        item_id: string;
+        method: string;
+        activity_type?: string | null;
+        post_id?: string;
+    };
+    sign_up: {
+        method: string;
+    };
+    spend_virtual_currency: {
+        item_name: string;
+        virtual_currency_name: string;
+        value: number;
+    };
+    tutorial_begin: undefined;
+    tutorial_complete: undefined;
+    unlock_achievement: {
+        achievement_id: string;
+    };
+    view_cart: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    view_item: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    view_item_list: {
+        items?: Item[];
+        item_list_id?: string;
+        item_list_name?: string;
+    };
+    view_promotion: {
+        items?: Item[];
+        location_id?: string;
+        creative_name?: string;
+        creative_slot?: string;
+        promotion_id?: string;
+        promotion_name?: string;
+    };
+    working_lead: {
+        currency: string;
+        value: number;
+        lead_status?: string;
+    };
+    ad_impression: {
+        value?: number;
+        currency?: string;
+        ad_format?: string;
+        ad_platform?: string;
+        ad_source?: string;
+        ad_unit_name?: string;
+    };
+    app_open: undefined;
+    campaign_details: {
+        source: string;
+        medium: string;
+        campaign: string;
+        term?: string;
+        content?: string;
+        aclid?: string;
+        cp1?: string;
+    };
+    screen_view: {
+        screen_name?: string;
+        screen_class?: string;
+    };
+    view_search_results: {
+        search_term: string;
+    };
+};
+type AllowedPropertyValues = string | number | boolean | null;
+type EventName = Lowercase<string>;
+type CustomEventProperties = Record<Lowercase<string>, AllowedPropertyValues>;
+type TrackProperties<T extends EventName = EventName> = T extends keyof StandardEventProperties ? StandardEventProperties[T] : CustomEventProperties;
+interface UserData {
+    userId: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    dateOfBirth?: string;
+    gender?: string;
+    city?: string;
+    state?: string;
+    postal?: string;
+    country?: string;
+}
+type ThirdPartyTracker = <T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, event_id?: string) => void;
+interface PlatformInfo {
+    os?: string;
+    os_name?: string;
+    os_version?: string;
+    browser?: string;
+    browser_name?: string;
+    browser_version?: string;
+    platform?: 'ios' | 'android' | 'web' | 'macos' | 'windows' | 'linux' | 'unknown';
+}
+interface DeviceInfo {
+    device?: string;
+    device_id?: string;
+    device_type?: string;
+    device_vendor?: string;
+    device_pixel_ratio?: string;
+    screen_resolution?: `${number}x${number}`;
+}
+interface EnvironmentInfo {
+    release?: string;
+    language?: string;
+    timezone?: string;
+    environment?: 'development' | 'production';
+}
+interface SourceInfo {
+    source_url?: string;
+    source?: 'app' | 'web' | 'offline';
+}
+interface ThirdPartyFields {
+    /**
+     * Meta pixel fields
+     * ref: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters#fbc
+     * Stored in the _fbc/_fbp browser cookie under your domain
+     */
+    fbc?: string;
+    fbp?: string;
+    /**
+     * Google Analytics fields
+     */
+    gclid?: string;
+}
+interface UTMParams {
+    utm_source?: string;
+    utm_medium?: string;
+    utm_campaign?: string;
+    utm_term?: string;
+    utm_content?: string;
+}
+interface TrackTags extends PlatformInfo, DeviceInfo, EnvironmentInfo, SourceInfo, ThirdPartyFields, UTMParams {
+    [key: string]: string | undefined;
+}
+interface CreateTrackEventDTO<T extends EventName = EventName> {
+    name: string;
+    tags: TrackTags;
+    visitor_id: string;
+    properties?: TrackProperties<T>;
+    timestamp: string;
+}
+interface TrackEventResponse {
+    /**
+     * track event id
+     * some tracking system will use event_id and event_name for deduplication
+     * */
+    id: string;
+}
+type VisitorProperties = Record<Lowercase<string>, AllowedPropertyValues>;
+interface Visitor {
+    id: string;
+    device_id: string;
+    properties: VisitorProperties;
+}
+interface CreateVisitorDTO {
+    device_id: string;
+    properties?: VisitorProperties;
+}
+interface UpdateVisitorDTO {
+    properties: VisitorProperties;
+}
+type ThirdPartyUserSetter = (properties: VisitorProperties) => void;
+
+export type { AllowedPropertyValues, CreateTrackEventDTO, CreateVisitorDTO, CustomEventProperties, DeviceInfo, EnvironmentInfo, EventName, Item, PlatformInfo, SourceInfo, StandardEventProperties, ThirdPartyFields, ThirdPartyTracker, ThirdPartyUserSetter, TrackEventResponse, TrackProperties, TrackTags, UTMParams, UpdateVisitorDTO, UserData, Visitor, VisitorProperties };

package/dist/types/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/types/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}