@reservamos/browser-analytics 0.2.2 → 0.3.0

package/dist/browser-analytics.d.ts

@@ -19,7 +19,8 @@ declare const customEventSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[
 export type CustomEventProps = z.infer<typeof customEventSchema>;
 export type AllowedPrimitive = string | boolean | number | undefined;
 export type EventData = Record<string, AllowedPrimitive | AllowedPrimitive[]>;
-declare function trackCustomEvent(eventName: string, eventData?: EventData): void;
+export type EventMetadata = EventData;
+declare function trackCustomEvent(eventName: string, eventData?: EventData, meta?: EventMetadata): void;
 declare const interestInHomeSchema: z.ZodObject<{
 	product: z.ZodEffects<z.ZodEnum<[
 		"web",
@@ -34,7 +35,7 @@ declare const interestInHomeSchema: z.ZodObject<{
 	product: "web" | "web-mobile" | "ios" | "android" | "app";
 }>;
 export type InterestInHomeProps = z.infer<typeof interestInHomeSchema>;
-declare function trackInterestInHome(eventData: InterestInHomeProps, meta?: EventData): void;
+declare function trackInterestInHome(eventData: InterestInHomeProps, meta?: EventMetadata): void;
 declare const interestInSearchSchema: z.ZodObject<{
 	product: z.ZodEffects<z.ZodEnum<[
 		"web",
@@ -49,7 +50,7 @@ declare const interestInSearchSchema: z.ZodObject<{
 	product: "web" | "web-mobile" | "ios" | "android" | "app";
 }>;
 export type InterestInSearchProps = z.infer<typeof interestInSearchSchema>;
-declare function trackInterestInSearch(eventData: InterestInSearchProps, meta?: EventData): void;
+declare function trackInterestInSearch(eventData: InterestInSearchProps, meta?: EventMetadata): void;
 declare const passengersCreatedSchema: z.ZodObject<{
 	Trips: z.ZodArray<z.ZodType<{
 		"Departure Arrival": string;
@@ -184,7 +185,7 @@ declare const passengersCreatedSchema: z.ZodObject<{
 	"Trip Count"?: number | undefined;
 }>;
 export type PassengersCreatedProps = z.infer<typeof passengersCreatedSchema>;
-declare function trackPassengersCreated(eventProps: PassengersCreatedProps, meta?: EventData): void;
+declare function trackPassengersCreated(eventProps: PassengersCreatedProps, meta?: EventMetadata): void;
 declare const paymentAttemptSchema: z.ZodObject<{
 	Trips: z.ZodArray<z.ZodType<{
 		"Departure Arrival": string;
@@ -381,7 +382,7 @@ declare const pickedDepartureSchema: z.ZodObject<{
 	Line?: string | undefined;
 }>;
 export type PickedDepartureProps = z.infer<typeof pickedDepartureSchema>;
-declare function trackSearch(eventData: PickedDepartureProps, meta?: EventData): void;
+declare function trackSearch(eventData: PickedDepartureProps, meta?: EventMetadata): void;
 declare const purchaseAttemptSchema: z.ZodObject<{
 	Trips: z.ZodArray<z.ZodType<{
 		"Departure Arrival": string;
@@ -516,7 +517,7 @@ declare const purchaseAttemptSchema: z.ZodObject<{
 	Total: number;
 }>;
 export type PurchaseAttemptProps = z.infer<typeof purchaseAttemptSchema>;
-declare function trackPurchaseAttempt(eventData: PurchaseAttemptProps, meta?: EventData): void;
+declare function trackPurchaseAttempt(eventData: PurchaseAttemptProps, meta?: EventMetadata): void;
 declare const searchSchema: z.ZodObject<{
 	Departure: z.ZodEffects<z.ZodString, string, string>;
 	"Departure Delta": z.ZodNumber;
@@ -561,7 +562,7 @@ declare const searchSchema: z.ZodObject<{
 	"Trip Length"?: number | undefined;
 }>;
 export type SearchProps = z.infer<typeof searchSchema>;
-declare function trackSearch$1(eventData: SearchProps, meta?: EventData): void;
+declare function trackSearch$1(eventData: SearchProps, meta?: EventMetadata): void;
 declare const seatChangeSchema: z.ZodObject<{
 	Arrival: z.ZodEffects<z.ZodString, string, string>;
 	Departure: z.ZodEffects<z.ZodString, string, string>;
@@ -618,7 +619,7 @@ declare const seatChangeSchema: z.ZodObject<{
 	Stops?: number | undefined;
 }>;
 export type SeatChangeProps = z.infer<typeof seatChangeSchema>;
-declare function trackSeatChange(eventProps: SeatChangeProps, meta?: EventData): void;
+declare function trackSeatChange(eventProps: SeatChangeProps, meta?: EventMetadata): void;
 declare const viewResultsSchema: z.ZodObject<{
 	"Bus count": z.ZodNumber;
 	Departure: z.ZodEffects<z.ZodString, string, string>;
@@ -660,7 +661,7 @@ declare const viewResultsSchema: z.ZodObject<{
 	"Has Frequent Buses"?: boolean | undefined;
 }>;
 export type ViewResultsProps = z.infer<typeof viewResultsSchema>;
-declare function trackViewResults(eventData: ViewResultsProps, meta?: EventData): void;
+declare function trackViewResults(eventData: ViewResultsProps, meta?: EventMetadata): void;
 declare const CreateAnonymousProfileSchema: z.ZodEffects<z.ZodObject<{
 	email: z.ZodOptional<z.ZodString>;
 	phone: z.ZodOptional<z.ZodString>;
@@ -699,7 +700,6 @@ export type DefaultProperties = z.infer<typeof IdentifySchema>;
 export interface UserProperties extends DefaultProperties, Record<string, string | number | boolean | undefined> {
 }
 declare function identify(userId: string, properties?: UserProperties): Promise<void>;
-declare function trackTest(): void;
 declare const InitConfigSchema: z.ZodObject<{
 	/**
 	 * The Mixpanel token used for authenticating API requests.
@@ -718,7 +718,7 @@ declare const InitConfigSchema: z.ZodObject<{
 	 * Optional flag to determine if the sandbox environment should be used.
 	 * When set to true, the sandbox environment will be used; otherwise, the production environment will be used.
 	 */
-	isSandbox: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+	isSandbox: z.ZodOptional<z.ZodBoolean>;
 	/**
 	 * Optional proxy URL for Mixpanel requests.
 	 */
@@ -730,8 +730,8 @@ declare const InitConfigSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
 	mixpanelToken: string;
 	identificationKey: string;
-	isSandbox: boolean;
 	debug?: boolean | undefined;
+	isSandbox?: boolean | undefined;
 	mixpanelProxyUrl?: string | undefined;
 	identifyProxyUrl?: string | undefined;
 }, {
@@ -747,8 +747,10 @@ declare const InitConfigSchema: z.ZodObject<{
  */
 export type InitConfig = z.infer<typeof InitConfigSchema>;
 declare function init(config: InitConfig): Promise<void>;
+declare function isTrackerReady(): boolean;
 declare const analytics: {
 	init: typeof init;
+	isReady: typeof isTrackerReady;
 	identify: typeof identify;
 	identifiers: {
 		getFingerprintId: () => string | null;
@@ -758,14 +760,13 @@ declare const analytics: {
 		createAnonymousProfile: typeof createAnonymousProfile;
 	};
 	track: {
-		test: typeof trackTest;
 		search: typeof trackSearch$1;
 		seatChange: typeof trackSeatChange;
 		interestInHome: typeof trackInterestInHome;
 		interestInSearch: typeof trackInterestInSearch;
 		viewResults: typeof trackViewResults;
 		passengersCreated: typeof trackPassengersCreated;
-		paymentAttempt: (eventProps: PaymentAttemptProps) => Promise<void>;
+		paymentAttempt: (eventProps: PaymentAttemptProps, meta?: EventMetadata) => Promise<void>;
 		purchaseAttempt: typeof trackPurchaseAttempt;
 		pickedDeparture: typeof trackSearch;
 		customEvent: typeof trackCustomEvent;

package/dist/browser-analytics.esm.js

@@ -13080,16 +13080,16 @@ const productValidation = z.enum(PRODUCT_TYPES).refine((val) => PRODUCT_TYPES.in
 const interestInHomeSchema = z.object({
   product: productValidation
 });
-const EVENT_NAME$9 = "Interest In Home";
+const EVENT_NAME$8 = "Interest In Home";
 function trackInterestInHome(eventData, meta = {}) {
-  trackEvent(EVENT_NAME$9, eventData, meta);
+  trackEvent(EVENT_NAME$8, eventData, meta);
 }
 const interestInSearchSchema = z.object({
   product: productValidation
 });
-const EVENT_NAME$8 = "Interest In Search";
+const EVENT_NAME$7 = "Interest In Search";
 function trackInterestInSearch(eventData, meta = {}) {
-  trackEvent(EVENT_NAME$8, eventData, meta);
+  trackEvent(EVENT_NAME$7, eventData, meta);
 }
 const dateValidation = (val) => {
   const dateRegex2 = /^\d{4}-\d{2}-\d{2}$/;
@@ -13163,9 +13163,9 @@ const passengersCreatedSchema = z.object({
   "Total": numberField("Total"),
   "product": productValidation
 }).strict();
-const EVENT_NAME$7 = "Passengers Created";
+const EVENT_NAME$6 = "Passengers Created";
 function trackPassengersCreated(eventProps, meta = {}) {
-  trackEvent(EVENT_NAME$7, eventProps, meta);
+  trackEvent(EVENT_NAME$6, eventProps, meta);
 }
 const paymentAttemptSchema = z.object({
   "Trips": arrayField(tripSchema, "Trips", 1),
@@ -13175,9 +13175,9 @@ const paymentAttemptSchema = z.object({
   "Total": numberField("Total"),
   "product": productValidation
 }).strict();
-const EVENT_NAME$6 = "Payment Attempt";
-const trackPaymentAttempt = async (eventProps) => {
-  trackEvent(EVENT_NAME$6, eventProps);
+const EVENT_NAME$5 = "Payment Attempt";
+const trackPaymentAttempt = async (eventProps, meta = {}) => {
+  trackEvent(EVENT_NAME$5, eventProps, meta);
 };
 const pickedDepartureSchema = z.object({
   "Arrival": z.string().refine(dateValidation, {
@@ -13201,9 +13201,9 @@ const pickedDepartureSchema = z.object({
   "Recommended Trip": z.boolean(),
   "Recommended Trip Type": z.string().optional()
 });
-const EVENT_NAME$5 = "Picked Departure";
+const EVENT_NAME$4 = "Picked Departure";
 function trackSearch$1(eventData, meta = {}) {
-  trackEvent(EVENT_NAME$5, eventData, meta);
+  trackEvent(EVENT_NAME$4, eventData, meta);
 }
 const purchaseAttemptSchema = z.object({
   "Trips": arrayField(tripSchema, "Trips", 1),
@@ -13212,9 +13212,9 @@ const purchaseAttemptSchema = z.object({
   "Total": numberField("Total"),
   "product": productValidation
 }).strict();
-const EVENT_NAME$4 = "Purchase Attempt";
+const EVENT_NAME$3 = "Purchase Attempt";
 function trackPurchaseAttempt(eventData, meta = {}) {
-  trackEvent(EVENT_NAME$4, eventData, meta);
+  trackEvent(EVENT_NAME$3, eventData, meta);
 }
 const searchSchema = z.object({
   "Departure": z.string().refine(dateValidation, {
@@ -13233,9 +13233,9 @@ const searchSchema = z.object({
   "Trip Length": z.number().positive().optional(),
   "product": productValidation
 });
-const EVENT_NAME$3 = "Search";
+const EVENT_NAME$2 = "Search";
 function trackSearch(eventData, meta = {}) {
-  trackEvent(EVENT_NAME$3, eventData, meta);
+  trackEvent(EVENT_NAME$2, eventData, meta);
 }
 const seatChangeSchema = z.object({
   "Arrival": z.string().refine(dateValidation, {
@@ -13259,13 +13259,13 @@ const seatChangeSchema = z.object({
   }),
   "product": productValidation
 });
-const EVENT_NAME$2 = "Seat Change";
+const EVENT_NAME$1 = "Seat Change";
 function trackSeatChange(eventProps, meta = {}) {
-  trackEvent(EVENT_NAME$2, eventProps, meta);
+  trackEvent(EVENT_NAME$1, eventProps, meta);
 }
-const EVENT_NAME$1 = "View Results";
+const EVENT_NAME = "View Results";
 function trackViewResults(eventData, meta = {}) {
-  trackEvent(EVENT_NAME$1, eventData, meta);
+  trackEvent(EVENT_NAME, eventData, meta);
 }
 const viewResultsSchema = z.object({
   "Bus count": z.number().int("Bus count must be an integer"),
@@ -13300,7 +13300,7 @@ const InitConfigSchema = z.object({
    * Optional flag to determine if the sandbox environment should be used.
    * When set to true, the sandbox environment will be used; otherwise, the production environment will be used.
    */
-  isSandbox: z.boolean().optional().default(false),
+  isSandbox: z.boolean().optional(),
   /**
    * Optional proxy URL for Mixpanel requests.
    */
@@ -13435,10 +13435,10 @@ async function trackEvent(eventName, eventProperties, meta = {}) {
     console.error(`Error tracking event '${eventName}':`, error);
   }
 }
-function trackCustomEvent(eventName, eventData = {}) {
+function trackCustomEvent(eventName, eventData = {}, meta = {}) {
   try {
     eventNameSchema.parse(eventName);
-    trackEvent(eventName, eventData);
+    trackEvent(eventName, eventData, meta);
   } catch (error) {
     console.error("Error trackCustomEvent:", error);
     return;
@@ -15996,10 +15996,6 @@ async function identify(userId, properties = {}) {
     });
   }
 }
-const EVENT_NAME = "Track Test";
-function trackTest() {
-  trackEvent(EVENT_NAME, {});
-}
 const origin = window.location.origin;
 const coreAPIConfig = {
   sandbox: {
@@ -16047,8 +16043,12 @@ async function init(config) {
   jsApiClientExports.setConfig(apiConfig);
   onLoaded();
 }
+function isTrackerReady() {
+  return mixpanelService.isReady();
+}
 const analytics = {
   init,
+  isReady: isTrackerReady,
   identify,
   identifiers: {
     getFingerprintId: fingerprintService.getCachedFingerprint,
@@ -16058,7 +16058,6 @@ const analytics = {
     createAnonymousProfile
   },
   track: {
-    test: trackTest,
     search: trackSearch,
     seatChange: trackSeatChange,
     interestInHome: trackInterestInHome,