@shware/analytics 3.6.4 → 3.7.0

package/dist/track/lintrk.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/track/lintrk.ts"],"sourcesContent":["export interface Lintrk {\n  lintrk(event: 'track', params: { conversion_id: number; event_id?: string }): void;\n\n  /** reference: https://www.linkedin.com/help/lms/answer/a6246095 */\n  lintrk(event: 'setUserData', params: { email: string }): void;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/track/lintrk.d.ts

@@ -1,12 +0,0 @@
-interface Lintrk {
-    lintrk(event: 'track', params: {
-        conversion_id: number;
-        event_id?: string;
-    }): void;
-    /** reference: https://www.linkedin.com/help/lms/answer/a6246095 */
-    lintrk(event: 'setUserData', params: {
-        email: string;
-    }): void;
-}
-
-export type { Lintrk };

package/dist/track/lintrk.mjs.map

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

package/dist/track/oaiq.d.ts

@@ -1,111 +0,0 @@
-import { Item } from './gtag.js';
-import { EventName, TrackName, TrackProperties } from './types.js';
-
-declare const NON_AD_EVENTS: string[];
-/**
- * Content item shared by `contents` and `plan_enrollment` events.
- * https://developers.openai.com/ads/supported-events
- */
-type ContentItem = {
-    id?: string;
-    name?: string;
-    content_type?: string;
-    quantity?: number;
-    /** Per-item monetary value in ISO 4217 minor units (e.g., 12,999 = $129.99 USD). */
-    amount?: number;
-    currency?: string;
-};
-type ContentsData = {
-    type: 'contents';
-    /** Monetary value in ISO 4217 minor units (e.g., 12,999 = $129.99 USD). */
-    amount?: number;
-    currency?: string;
-    contents?: ContentItem[];
-};
-type CustomerActionData = {
-    type: 'customer_action';
-    amount?: number;
-    currency?: string;
-};
-type PlanEnrollmentData = {
-    type: 'plan_enrollment';
-    plan_id?: string;
-    amount?: number;
-    currency?: string;
-    contents?: ContentItem[];
-};
-type CustomEventData = {
-    type: 'custom';
-    amount?: number;
-    currency?: string;
-    contents?: ContentItem[];
-};
-type EventData = ContentsData | CustomerActionData | PlanEnrollmentData | CustomEventData;
-/**
- * Standard event names and the `data` shape each one expects.
- * https://developers.openai.com/ads/supported-events
- */
-type StandardEvents = {
-    appointment_scheduled: CustomerActionData;
-    checkout_started: ContentsData;
-    contents_viewed: ContentsData;
-    items_added: ContentsData;
-    lead_created: CustomerActionData;
-    order_created: ContentsData;
-    page_viewed: ContentsData;
-    registration_completed: CustomerActionData;
-    subscription_created: PlanEnrollmentData;
-    trial_started: PlanEnrollmentData;
-};
-type StandardEvent = keyof StandardEvents;
-/**
- * Identity fields passed to `oaiq("init", ...)` for conversion matching. Email and external id
- * must be pre-hashed as lowercase 64-char SHA-256 hex strings; the rest are sent as raw values.
- * https://developers.openai.com/ads/measurement-pixel
- */
-type OAIQUser = {
-    email_sha256?: string;
-    external_id_sha256?: string;
-    /** Two-letter ISO 3166-1 country code (e.g. "US"). */
-    country?: string;
-    /** Lowercased, max 128 characters. */
-    city?: string;
-    /** Max 32 characters. */
-    zip_code?: string;
-};
-type InitConfig = {
-    pixelId: string;
-    /** Log SDK activity to the browser console. */
-    debug?: boolean;
-    user?: OAIQUser;
-};
-/**
- * Fourth argument of `oaiq("measure", ...)`. Required for custom events (carries
- * `custom_event_name`); optional for standard events.
- */
-type MeasureOptions = {
-    /** Shared with the Conversions API to deduplicate the same conversion across browser and server. */
-    event_id?: string;
-    /** Required for custom events; 1-64 chars of letters, numbers, underscores, or dashes. */
-    custom_event_name?: string;
-    /** When true, opts the event out of user-level personalization. */
-    opt_out?: boolean;
-};
-interface OAIQ {
-    oaiq(command: 'init', config: InitConfig): void;
-    oaiq<T extends StandardEvent>(command: 'measure', event: T, data: StandardEvents[T], options?: MeasureOptions): void;
-    oaiq(command: 'measure', event: 'custom', data: CustomEventData, options: MeasureOptions & {
-        custom_event_name: string;
-    }): void;
-}
-/** Convert a major-unit amount (e.g., 129.99) into ISO 4217 minor units (e.g., 12,999). */
-declare function toMinorUnits(value?: number, currency?: string): number | undefined;
-declare function mapContents(items?: Item[], currency?: string): ContentItem[] | undefined;
-type MappedOAIEvent = {
-    type: StandardEvent | 'custom';
-    data: EventData;
-};
-/** Map an internal track event onto an OpenAI standard (or custom) conversion event. */
-declare function mapOAIEvent<T extends EventName>(name: TrackName<T>, properties?: TrackProperties<T>): MappedOAIEvent;
-
-export { type ContentItem, type ContentsData, type CustomEventData, type CustomerActionData, type EventData, type InitConfig, type MappedOAIEvent, type MeasureOptions, NON_AD_EVENTS, type OAIQ, type OAIQUser, type PlanEnrollmentData, type StandardEvent, type StandardEvents, mapContents, mapOAIEvent, toMinorUnits };

package/dist/track/rdt.d.ts

@@ -1,96 +0,0 @@
-import { Item } from './gtag.js';
-import { EventName, TrackName, TrackProperties } from './types.js';
-
-/** https://business.reddithelp.com/s/article/about-event-metadata */
-type Product = {
-    /**
-     * (Required) Product ID: Either the SKU or GTIN, which represents the variant ID, not the
-     * parent ID. If there are no variants, pass the assigned ID for that item.
-     */
-    id: string;
-    /** (Optional) Product Category: The group the product belongs to. */
-    name?: string;
-    /** (Optional) Product Name: The title of the product. */
-    category?: string;
-};
-/**
- * https://business.reddithelp.com/s/article/supported-conversion-events#supported-conversion-events
- * https://business.reddithelp.com/s/article/about-event-metadata
- * https://business.reddithelp.com/s/article/map-a-catalog-to-a-signal-source
- */
-type StandardEvents = {
-    PageVisit: {
-        conversionId?: string;
-        products?: Product[];
-    };
-    ViewContent: {
-        conversionId?: string;
-        products?: Product[];
-    };
-    Search: {
-        conversionId?: string;
-        products?: Product[];
-    };
-    AddToCart: {
-        value?: number;
-        currency?: string;
-        itemCount?: number;
-        conversionId?: string;
-        products?: Product[];
-    };
-    AddToWishlist: {
-        value?: number;
-        currency?: string;
-        itemCount?: number;
-        conversionId?: string;
-        products?: Product[];
-    };
-    Purchase: {
-        value?: number;
-        currency?: string;
-        itemCount?: number;
-        conversionId?: string;
-        products?: Product[];
-    };
-    Lead: {
-        value?: number;
-        currency?: string;
-        conversionId?: string;
-        products?: Product[];
-    };
-    SignUp: {
-        value?: number;
-        currency?: string;
-        conversionId?: string;
-        products?: Product[];
-    };
-};
-type PixelId = `a2_${string}`;
-type MatchKeys = {
-    email?: string;
-    phoneNumber?: string;
-    externalId?: string;
-    idfa?: string;
-    aaid?: string;
-};
-type CustomEventParams<T extends string = string> = {
-    customEventName: T;
-    value?: number;
-    currency?: string;
-    itemCount?: number;
-    conversionId?: string;
-    products?: Product[];
-};
-interface RDT {
-    rdt(event: 'init', pixelId: PixelId, matchKeys?: MatchKeys): void;
-    rdt<T extends keyof StandardEvents>(event: 'track', type: T, params?: StandardEvents[T]): void;
-    rdt(event: 'track', type: 'Custom', params: CustomEventParams): void;
-}
-type Mapped<F extends keyof StandardEvents> = [F, StandardEvents[F]];
-type Missed<F extends string> = ['Custom', CustomEventParams<F>];
-declare function mapItems(items?: Item[]): undefined | Product[];
-declare function mapRDTEvent<T extends EventName>(name: TrackName<T>, properties?: TrackProperties<T>, eventId?: string): Mapped<keyof StandardEvents> | Missed<TrackName<T>>;
-type ServerStandardEvent = 'PAGE_VISIT' | 'VIEW_CONTENT' | 'SEARCH' | 'ADD_TO_CART' | 'ADD_TO_WISHLIST' | 'PURCHASE' | 'LEAD' | 'SIGN_UP';
-declare function mapServerStandardEvent(name: keyof StandardEvents): ServerStandardEvent;
-
-export { type CustomEventParams, type MatchKeys, type PixelId, type Product, type RDT, type ServerStandardEvent, type StandardEvents, mapItems, mapRDTEvent, mapServerStandardEvent };

package/dist/track/types.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/track/types.ts"],"sourcesContent":["import type { UserProvidedData as GAUserProvidedData, StandardEvents } from './gtag';\n\nexport type AllowedPropertyValues = string | number | boolean | null;\nexport type EventName = Lowercase<string> | 'CLS' | 'FCP' | 'INP' | 'LCP' | 'TTFB';\n\nexport type TrackName<T extends EventName = EventName> = T extends keyof StandardEvents\n  ? T\n  : EventName;\nexport type TrackProperties<T extends EventName = EventName> = T extends keyof StandardEvents\n  ? StandardEvents[T]\n  : Record<Lowercase<string>, AllowedPropertyValues>;\n\nexport type Platform = 'ios' | 'android' | 'web' | 'macos' | 'windows' | 'linux' | 'unknown';\nexport type Environment = 'development' | 'production';\n\nexport interface UserData {\n  userId: string;\n  email?: string;\n  firstName?: string;\n  lastName?: string;\n  phone?: string;\n  dateOfBirth?: string;\n  gender?: string;\n  city?: string;\n  state?: string;\n  postal?: string;\n  country?: string;\n}\n\nexport interface UserProvidedData extends GAUserProvidedData {\n  user_id?: string;\n  ip_address?: string;\n  user_agent?: string;\n  gender?: 'female' | 'male';\n  birthday?: { year: number; month: number; day: number };\n  // meta specific\n  fb_login_id?: string;\n  fb_page_id?: string;\n}\n\nexport type ThirdPartyTracker = <T extends EventName>(\n  name: TrackName<T>,\n  properties?: TrackProperties<T>,\n  event_id?: string\n) => void;\n\nexport interface PlatformInfo {\n  os?: string;\n  os_name?: string;\n  os_version?: string;\n  browser?: string;\n  browser_name?: string;\n  browser_version?: string;\n  /** @deprecated */\n  platform: Platform;\n}\n\nexport interface DeviceInfo {\n  device?: string;\n  device_id?: string;\n  device_type?: string;\n  device_vendor?: string;\n  device_model_id?: string;\n  device_pixel_ratio?: number;\n  screen_width?: number;\n  screen_height?: number;\n  screen_resolution?: `${number}x${number}`;\n}\n\nexport interface AppInfo {\n  /** iOS: IDFA, Android: Android Advertising ID */\n  advertising_id?: string;\n  install_referrer?: string;\n}\n\nexport interface EnvironmentInfo {\n  release?: string;\n  language?: string;\n  time_zone?: string;\n  /** @deprecated */\n  environment: Environment;\n}\n\nexport interface SourceInfo {\n  source_url?: string;\n  source?: 'app' | 'web' | 'offline';\n  page_referrer?: string;\n}\n\nexport interface AdvertisingInfo {\n  /**\n   * Meta pixel fields\n   * ref: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters#fbc\n   * Stored in the _fbc/_fbp browser cookie under your domain\n   * ref: https://www.facebook.com/business/help/2360940870872492?checkpoint_src=any\n   */\n  fbc?: string;\n  fbp?: string;\n  fbclid?: string;\n  ad_id?: string;\n  ad_name?: string;\n  adset_id?: string;\n  adset_name?: string;\n  campaign_id?: string;\n  campaign_name?: string;\n  placement?: string;\n  site_source_name?: string;\n  /** Google Analytics fields */\n  gclid?: string;\n  gclsrc?: string;\n  gad_source?: string;\n  gad_campaignid?: string;\n  /** Reddit Ads fields */\n  rdt_cid?: string;\n  rdt_uuid?: string;\n  /** LinkedIn Ads fields: get click id from url params or first-party cookie */\n  li_fat_id?: string;\n  // click ids\n  dclid?: string; // Google Display Network\n  ko_click_id?: string; // Kakao Ads\n  msclkid?: string; // Microsoft Ads (Bing Ads)\n  sccid?: string; // Snapchat Ads\n  ttclid?: string; // TikTok Ads\n  twclid?: string; // Twitter Ads (X Ads)\n  wbraid?: string; // Google Ads (for iOS privacy)\n  yclid?: string; // Yandex Ads\n}\n\nexport interface UTMParams {\n  utm_source?: string;\n  utm_medium?: string;\n  utm_campaign?: string;\n  utm_term?: string;\n  utm_content?: string;\n  utm_id?: string;\n  utm_source_platform?: string;\n  utm_creative_format?: string;\n  utm_marketing_tactic?: string;\n}\n\nexport interface TrackTags\n  extends\n    PlatformInfo,\n    DeviceInfo,\n    AppInfo,\n    EnvironmentInfo,\n    SourceInfo,\n    AdvertisingInfo,\n    UTMParams {\n  idempotency_key?: string;\n  [key: string]: string | number | boolean | null | undefined;\n}\n\nexport interface TrackEvent<T extends EventName = EventName> {\n  id: string;\n  name: TrackName<T>;\n  tags: TrackTags;\n  visitor_id: string;\n  session_id: string;\n  platform: Platform;\n  environment: Environment;\n  properties?: TrackProperties<T>;\n  created_at: string;\n}\n\nexport type TrackEventResponse = {\n  /** track event id: Meta Pixel will use event_id and event_name for deduplication */\n  id: string;\n}[];\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/track/types.d.ts

@@ -1,142 +0,0 @@
-import { StandardEvents, UserProvidedData as UserProvidedData$1 } from './gtag.js';
-
-type AllowedPropertyValues = string | number | boolean | null;
-type EventName = Lowercase<string> | 'CLS' | 'FCP' | 'INP' | 'LCP' | 'TTFB';
-type TrackName<T extends EventName = EventName> = T extends keyof StandardEvents ? T : EventName;
-type TrackProperties<T extends EventName = EventName> = T extends keyof StandardEvents ? StandardEvents[T] : Record<Lowercase<string>, AllowedPropertyValues>;
-type Platform = 'ios' | 'android' | 'web' | 'macos' | 'windows' | 'linux' | 'unknown';
-type Environment = 'development' | 'production';
-interface UserData {
-    userId: string;
-    email?: string;
-    firstName?: string;
-    lastName?: string;
-    phone?: string;
-    dateOfBirth?: string;
-    gender?: string;
-    city?: string;
-    state?: string;
-    postal?: string;
-    country?: string;
-}
-interface UserProvidedData extends UserProvidedData$1 {
-    user_id?: string;
-    ip_address?: string;
-    user_agent?: string;
-    gender?: 'female' | 'male';
-    birthday?: {
-        year: number;
-        month: number;
-        day: number;
-    };
-    fb_login_id?: string;
-    fb_page_id?: string;
-}
-type ThirdPartyTracker = <T extends EventName>(name: TrackName<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;
-    /** @deprecated */
-    platform: Platform;
-}
-interface DeviceInfo {
-    device?: string;
-    device_id?: string;
-    device_type?: string;
-    device_vendor?: string;
-    device_model_id?: string;
-    device_pixel_ratio?: number;
-    screen_width?: number;
-    screen_height?: number;
-    screen_resolution?: `${number}x${number}`;
-}
-interface AppInfo {
-    /** iOS: IDFA, Android: Android Advertising ID */
-    advertising_id?: string;
-    install_referrer?: string;
-}
-interface EnvironmentInfo {
-    release?: string;
-    language?: string;
-    time_zone?: string;
-    /** @deprecated */
-    environment: Environment;
-}
-interface SourceInfo {
-    source_url?: string;
-    source?: 'app' | 'web' | 'offline';
-    page_referrer?: string;
-}
-interface AdvertisingInfo {
-    /**
-     * 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
-     * ref: https://www.facebook.com/business/help/2360940870872492?checkpoint_src=any
-     */
-    fbc?: string;
-    fbp?: string;
-    fbclid?: string;
-    ad_id?: string;
-    ad_name?: string;
-    adset_id?: string;
-    adset_name?: string;
-    campaign_id?: string;
-    campaign_name?: string;
-    placement?: string;
-    site_source_name?: string;
-    /** Google Analytics fields */
-    gclid?: string;
-    gclsrc?: string;
-    gad_source?: string;
-    gad_campaignid?: string;
-    /** Reddit Ads fields */
-    rdt_cid?: string;
-    rdt_uuid?: string;
-    /** LinkedIn Ads fields: get click id from url params or first-party cookie */
-    li_fat_id?: string;
-    dclid?: string;
-    ko_click_id?: string;
-    msclkid?: string;
-    sccid?: string;
-    ttclid?: string;
-    twclid?: string;
-    wbraid?: string;
-    yclid?: string;
-}
-interface UTMParams {
-    utm_source?: string;
-    utm_medium?: string;
-    utm_campaign?: string;
-    utm_term?: string;
-    utm_content?: string;
-    utm_id?: string;
-    utm_source_platform?: string;
-    utm_creative_format?: string;
-    utm_marketing_tactic?: string;
-}
-interface TrackTags extends PlatformInfo, DeviceInfo, AppInfo, EnvironmentInfo, SourceInfo, AdvertisingInfo, UTMParams {
-    idempotency_key?: string;
-    [key: string]: string | number | boolean | null | undefined;
-}
-interface TrackEvent<T extends EventName = EventName> {
-    id: string;
-    name: TrackName<T>;
-    tags: TrackTags;
-    visitor_id: string;
-    session_id: string;
-    platform: Platform;
-    environment: Environment;
-    properties?: TrackProperties<T>;
-    created_at: string;
-}
-type TrackEventResponse = {
-    /** track event id: Meta Pixel will use event_id and event_name for deduplication */
-    id: string;
-}[];
-
-export type { AdvertisingInfo, AllowedPropertyValues, AppInfo, DeviceInfo, Environment, EnvironmentInfo, EventName, Platform, PlatformInfo, SourceInfo, ThirdPartyTracker, TrackEvent, TrackEventResponse, TrackName, TrackProperties, TrackTags, UTMParams, UserData, UserProvidedData };

package/dist/track/types.mjs.map

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

package/dist/visitor/types.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/visitor/types.ts"],"sourcesContent":["import type { UserProperties, UserProvidedData } from '../track/gtag';\nimport type { Environment, Platform } from '../track/types';\n\nexport type VisitorProperties = Record<Lowercase<string>, string | number | boolean | null>;\n\nexport interface Visitor {\n  id: string;\n  device_id: string;\n  platform: Platform;\n  environment: Environment;\n  properties: VisitorProperties;\n}\n\nexport interface UpdateVisitorDTO {\n  user_id?: string;\n  distinct_id?: string;\n  data?: UserProvidedData;\n  properties?: UserProperties;\n}\n\nexport type ThirdPartyUserSetter = (dto: UpdateVisitorDTO) => void;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/visitor/types.d.ts

@@ -1,20 +0,0 @@
-import { UserProvidedData, UserProperties } from '../track/gtag.js';
-import { Platform, Environment } from '../track/types.js';
-
-type VisitorProperties = Record<Lowercase<string>, string | number | boolean | null>;
-interface Visitor {
-    id: string;
-    device_id: string;
-    platform: Platform;
-    environment: Environment;
-    properties: VisitorProperties;
-}
-interface UpdateVisitorDTO {
-    user_id?: string;
-    distinct_id?: string;
-    data?: UserProvidedData;
-    properties?: UserProperties;
-}
-type ThirdPartyUserSetter = (dto: UpdateVisitorDTO) => void;
-
-export type { ThirdPartyUserSetter, UpdateVisitorDTO, Visitor, VisitorProperties };

package/dist/visitor/types.mjs.map

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

package/dist/web/index.d.ts

@@ -1,10 +0,0 @@
-import { Storage } from '../setup/index.js';
-import { TrackTags } from '../track/types.js';
-import '../visitor/types.js';
-import '../track/gtag.js';
-
-declare function getDeviceId(): string;
-declare function getTags(): Promise<TrackTags>;
-declare const storage: Storage;
-
-export { getDeviceId, getTags, storage };