@shware/analytics 0.1.15 → 0.1.17

package/dist/index.d.ts

@@ -1,501 +1,7 @@
-import { z } from 'zod';
-
-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;
-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 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;
-}
-type ThirdPartyUserSetter = (properties: VisitorProperties) => void;
-
-interface Storage {
-    getItem: (key: string) => (string | null) | Promise<string | null>;
-    setItem: (key: string, value: string) => void | Promise<void>;
-}
-interface Options {
-    release: string;
-    storage: Storage;
-    endpoint: string;
-    getTags: () => TrackTags | Promise<TrackTags>;
-    getDeviceId: () => string | Promise<string>;
-    thirdPartyTrackers?: ThirdPartyTracker[];
-    thirdPartyUserSetters?: ThirdPartyUserSetter[];
-}
-declare function setupAnalytics(init: Options): void;
-
-interface TrackOptions {
-    enableThirdPartyTracking?: boolean;
-    onSucceed?: (response?: TrackEventResponse) => void;
-    onError?: (error: unknown) => void;
-}
-declare function track<T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, trackOptions?: TrackOptions): void;
-
-declare function getVisitor(): Promise<Visitor>;
-declare function setVisitor(properties: VisitorProperties): Promise<Visitor>;
-
-declare const createTrackEventSchema: z.ZodObject<{
-    name: z.ZodString;
-    visitor_id: z.ZodBigInt;
-    tags: z.ZodObject<{
-        os: z.ZodOptional<z.ZodString>;
-        os_name: z.ZodOptional<z.ZodString>;
-        os_version: z.ZodOptional<z.ZodString>;
-        browser: z.ZodOptional<z.ZodString>;
-        browser_name: z.ZodOptional<z.ZodString>;
-        browser_version: z.ZodOptional<z.ZodString>;
-        platform: z.ZodOptional<z.ZodEnum<["ios", "android", "web", "macos", "windows", "linux", "unknown"]>>;
-        device: z.ZodOptional<z.ZodString>;
-        device_id: z.ZodOptional<z.ZodString>;
-        device_type: z.ZodOptional<z.ZodString>;
-        device_vendor: z.ZodOptional<z.ZodString>;
-        device_pixel_ratio: z.ZodOptional<z.ZodString>;
-        screen_resolution: z.ZodOptional<z.ZodEffects<z.ZodString, `${number}x${number}`, string>>;
-        release: z.ZodOptional<z.ZodString>;
-        language: z.ZodOptional<z.ZodString>;
-        timezone: z.ZodOptional<z.ZodString>;
-        environment: z.ZodOptional<z.ZodEnum<["development", "production"]>>;
-        source_url: z.ZodOptional<z.ZodString>;
-        source: z.ZodOptional<z.ZodEnum<["web", "app", "offline"]>>;
-        fbc: z.ZodOptional<z.ZodString>;
-        fbp: z.ZodOptional<z.ZodString>;
-        gclid: z.ZodOptional<z.ZodString>;
-        utm_source: z.ZodOptional<z.ZodString>;
-        utm_medium: z.ZodOptional<z.ZodString>;
-        utm_campaign: z.ZodOptional<z.ZodString>;
-        utm_term: z.ZodOptional<z.ZodString>;
-        utm_content: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        os?: string | undefined;
-        os_name?: string | undefined;
-        os_version?: string | undefined;
-        browser?: string | undefined;
-        browser_name?: string | undefined;
-        browser_version?: string | undefined;
-        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
-        device?: string | undefined;
-        device_id?: string | undefined;
-        device_type?: string | undefined;
-        device_vendor?: string | undefined;
-        device_pixel_ratio?: string | undefined;
-        screen_resolution?: `${number}x${number}` | undefined;
-        release?: string | undefined;
-        language?: string | undefined;
-        timezone?: string | undefined;
-        environment?: "development" | "production" | undefined;
-        source_url?: string | undefined;
-        source?: "web" | "app" | "offline" | undefined;
-        fbc?: string | undefined;
-        fbp?: string | undefined;
-        gclid?: string | undefined;
-        utm_source?: string | undefined;
-        utm_medium?: string | undefined;
-        utm_campaign?: string | undefined;
-        utm_term?: string | undefined;
-        utm_content?: string | undefined;
-    }, {
-        os?: string | undefined;
-        os_name?: string | undefined;
-        os_version?: string | undefined;
-        browser?: string | undefined;
-        browser_name?: string | undefined;
-        browser_version?: string | undefined;
-        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
-        device?: string | undefined;
-        device_id?: string | undefined;
-        device_type?: string | undefined;
-        device_vendor?: string | undefined;
-        device_pixel_ratio?: string | undefined;
-        screen_resolution?: string | undefined;
-        release?: string | undefined;
-        language?: string | undefined;
-        timezone?: string | undefined;
-        environment?: "development" | "production" | undefined;
-        source_url?: string | undefined;
-        source?: "web" | "app" | "offline" | undefined;
-        fbc?: string | undefined;
-        fbp?: string | undefined;
-        gclid?: string | undefined;
-        utm_source?: string | undefined;
-        utm_medium?: string | undefined;
-        utm_campaign?: string | undefined;
-        utm_term?: string | undefined;
-        utm_content?: string | undefined;
-    }>;
-    properties: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, Record<string, string | number | boolean | null>, Record<string, string | number | boolean | null>>;
-}, "strip", z.ZodTypeAny, {
-    visitor_id: bigint;
-    name: string;
-    tags: {
-        os?: string | undefined;
-        os_name?: string | undefined;
-        os_version?: string | undefined;
-        browser?: string | undefined;
-        browser_name?: string | undefined;
-        browser_version?: string | undefined;
-        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
-        device?: string | undefined;
-        device_id?: string | undefined;
-        device_type?: string | undefined;
-        device_vendor?: string | undefined;
-        device_pixel_ratio?: string | undefined;
-        screen_resolution?: `${number}x${number}` | undefined;
-        release?: string | undefined;
-        language?: string | undefined;
-        timezone?: string | undefined;
-        environment?: "development" | "production" | undefined;
-        source_url?: string | undefined;
-        source?: "web" | "app" | "offline" | undefined;
-        fbc?: string | undefined;
-        fbp?: string | undefined;
-        gclid?: string | undefined;
-        utm_source?: string | undefined;
-        utm_medium?: string | undefined;
-        utm_campaign?: string | undefined;
-        utm_term?: string | undefined;
-        utm_content?: string | undefined;
-    };
-    properties: Record<string, string | number | boolean | null>;
-}, {
-    visitor_id: bigint;
-    name: string;
-    tags: {
-        os?: string | undefined;
-        os_name?: string | undefined;
-        os_version?: string | undefined;
-        browser?: string | undefined;
-        browser_name?: string | undefined;
-        browser_version?: string | undefined;
-        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
-        device?: string | undefined;
-        device_id?: string | undefined;
-        device_type?: string | undefined;
-        device_vendor?: string | undefined;
-        device_pixel_ratio?: string | undefined;
-        screen_resolution?: string | undefined;
-        release?: string | undefined;
-        language?: string | undefined;
-        timezone?: string | undefined;
-        environment?: "development" | "production" | undefined;
-        source_url?: string | undefined;
-        source?: "web" | "app" | "offline" | undefined;
-        fbc?: string | undefined;
-        fbp?: string | undefined;
-        gclid?: string | undefined;
-        utm_source?: string | undefined;
-        utm_medium?: string | undefined;
-        utm_campaign?: string | undefined;
-        utm_term?: string | undefined;
-        utm_content?: string | undefined;
-    };
-    properties: Record<string, string | number | boolean | null>;
-}>;
-declare const createVisitorSchema: z.ZodObject<{
-    device_id: z.ZodString;
-    properties: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, Record<string, string | number | boolean | null>, Record<string, string | number | boolean | null>>;
-}, "strip", z.ZodTypeAny, {
-    device_id: string;
-    properties: Record<string, string | number | boolean | null>;
-}, {
-    device_id: string;
-    properties: Record<string, string | number | boolean | null>;
-}>;
-declare const updateVisitorSchema: z.ZodObject<{
-    properties: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, Record<string, string | number | boolean | null>, Record<string, string | number | boolean | null>>;
-}, "strip", z.ZodTypeAny, {
-    properties: Record<string, string | number | boolean | null>;
-}, {
-    properties: Record<string, string | number | boolean | null>;
-}>;
-
-export { type TrackProperties, type TrackTags, type VisitorProperties, createTrackEventSchema, createVisitorSchema, getVisitor, setVisitor, setupAnalytics, track, updateVisitorSchema };
+export { setupAnalytics } from './setup/index.js';
+export { track } from './track/index.js';
+export { getVisitor, setVisitor } from './visitor/index.js';
+export { createTrackEventSchema, createVisitorSchema, updateVisitorSchema } from './schema/index.js';
+export { TrackProperties, TrackTags, VisitorProperties } from './types/index.js';
+import 'axios';
+import 'zod';

package/dist/index.mjs

@@ -1,161 +1,8 @@
-// src/setup.ts
-import axios from "axios";
-import retry from "axios-retry";
-var config = {
-  http: null,
-  release: "0.0.0",
-  storage: null,
-  getTags: null,
-  getDeviceId: null,
-  thirdPartyTrackers: [],
-  thirdPartyUserSetters: []
-};
-function setupAnalytics(init) {
-  config.release = init.release;
-  config.storage = init.storage;
-  config.getTags = init.getTags;
-  config.getDeviceId = init.getDeviceId;
-  config.thirdPartyTrackers = init.thirdPartyTrackers ?? [];
-  config.thirdPartyUserSetters = init.thirdPartyUserSetters ?? [];
-  config.http = axios.create({ baseURL: init.endpoint, withCredentials: true, adapter: "fetch" });
-  retry(config.http, { retries: 5, retryDelay: retry.exponentialDelay });
-}
-
-// src/track.ts
-import { TokenBucket } from "limiter";
-
-// src/visitor.ts
-var key = "visitor_id";
-async function createVisitor() {
-  const dto = {
-    device_id: await config.getDeviceId(),
-    properties: await config.getTags()
-  };
-  const response = await config.http.post(`/visitors`, dto);
-  return response.data;
-}
-async function getOrCreateVisitor() {
-  const visitorId = await config.storage.getItem(key);
-  if (visitorId) {
-    try {
-      const response = await config.http.get(`/visitors/${visitorId}`);
-      return response.data;
-    } catch (e) {
-      const visitor2 = await createVisitor();
-      await config.storage.setItem(key, visitor2.id);
-      return visitor2;
-    }
-  } else {
-    const visitor2 = await createVisitor();
-    await config.storage.setItem(key, visitor2.id);
-    return visitor2;
-  }
-}
-var visitor = null;
-var visitorFetcher = null;
-async function getVisitor() {
-  if (visitor) return visitor;
-  if (visitorFetcher) return visitorFetcher;
-  visitorFetcher = getOrCreateVisitor();
-  visitor = await visitorFetcher;
-  visitorFetcher = null;
-  return visitor;
-}
-async function setVisitor(properties) {
-  const dto = { properties };
-  const { id } = await getVisitor();
-  const response = await config.http.patch(`/visitors/${id}`, dto);
-  config.thirdPartyUserSetters.forEach((setter) => setter(properties));
-  visitor = response.data;
-  return response.data;
-}
-
-// src/track.ts
-var defaultOptions = { enableThirdPartyTracking: true };
-var REQUEST_TOKENS = 2;
-var tokenBucket = new TokenBucket({
-  bucketSize: 20,
-  interval: "second",
-  tokensPerInterval: 1
-});
-async function trackAsync(name, properties, trackOptions = defaultOptions) {
-  var _a, _b;
-  try {
-    await tokenBucket.removeTokens(REQUEST_TOKENS);
-    const dto = {
-      name,
-      properties,
-      tags: await config.getTags(),
-      visitor_id: (await getVisitor()).id,
-      timestamp: (/* @__PURE__ */ new Date()).toISOString()
-    };
-    const { data } = await config.http.post(`/events`, dto);
-    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;
-    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));
-    (_a = trackOptions.onSucceed) == null ? void 0 : _a.call(trackOptions, data);
-  } catch (e) {
-    if (e instanceof Error) {
-      console.log("Failed to send track event:", e.message);
-    }
-    (_b = trackOptions.onError) == null ? void 0 : _b.call(trackOptions, e);
-  }
-}
-function track(name, properties, trackOptions = defaultOptions) {
-  trackAsync(name, properties, trackOptions).catch(console.error);
-}
-
-// src/schema.ts
-import { z } from "zod";
-var createTrackEventSchema = z.object({
-  name: z.string().trim().min(1).max(64),
-  visitor_id: z.coerce.bigint(),
-  tags: z.object({
-    os: z.string().optional(),
-    os_name: z.string().optional(),
-    os_version: z.string().optional(),
-    browser: z.string().optional(),
-    browser_name: z.string().optional(),
-    browser_version: z.string().optional(),
-    platform: z.enum(["ios", "android", "web", "macos", "windows", "linux", "unknown"]).optional(),
-    device: z.string().optional(),
-    device_id: z.string().trim().min(1).max(36).optional(),
-    device_type: z.string().optional(),
-    device_vendor: z.string().optional(),
-    device_pixel_ratio: z.string().optional(),
-    screen_resolution: z.string().regex(/^\d+x\d+$/).transform((v) => v).optional(),
-    release: z.string().optional(),
-    language: z.string().optional(),
-    timezone: z.string().optional(),
-    environment: z.enum(["development", "production"]).optional(),
-    source_url: z.string().optional(),
-    source: z.enum(["web", "app", "offline"]).optional(),
-    fbc: z.string().optional(),
-    fbp: z.string().optional(),
-    gclid: z.string().optional(),
-    utm_source: z.string().optional(),
-    utm_medium: z.string().optional(),
-    utm_campaign: z.string().optional(),
-    utm_term: z.string().optional(),
-    utm_content: z.string().optional()
-  }),
-  properties: z.record(
-    z.string().trim().min(1).max(128),
-    z.union([z.string().max(512), z.number(), z.boolean(), z.null()])
-  ).refine((data) => Object.keys(data).length <= 64)
-});
-var createVisitorSchema = z.object({
-  device_id: z.string().trim().min(1).max(36),
-  properties: z.record(
-    z.string().trim().min(1).max(128),
-    z.union([z.string().max(512), z.number(), z.boolean(), z.null()])
-  ).refine((data) => Object.keys(data).length <= 64)
-});
-var updateVisitorSchema = z.object({
-  properties: z.record(
-    z.string().trim().min(1).max(128),
-    z.union([z.string().max(512), z.number(), z.boolean(), z.null()])
-  ).refine((data) => Object.keys(data).length <= 64)
-});
+// src/index.ts
+import { setupAnalytics } from "./setup/index.mjs";
+import { track } from "./track/index.mjs";
+import { getVisitor, setVisitor } from "./visitor/index.mjs";
+import { createTrackEventSchema, createVisitorSchema, updateVisitorSchema } from "./schema/index.mjs";
 export {
   createTrackEventSchema,
   createVisitorSchema,