@reservamos/browser-analytics 0.1.3 → 0.1.4-alpha.10

package/dist/browser-analytics.d.ts

@@ -2,10 +2,468 @@
 
 import { z } from 'zod';
 
-/**
-  First test event to track, it purpose is to test the tracking library and the identification service.ws
- */
-export declare function trackTest(): void;
+declare const interestInHomeSchema: z.ZodObject<{
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+}>;
+export type InterestInHomeProps = z.infer<typeof interestInHomeSchema>;
+declare function trackInterestInHome(eventData: InterestInHomeProps): void;
+declare const interestInSearchSchema: z.ZodObject<{
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+}>;
+export type InterestInSearchProps = z.infer<typeof interestInSearchSchema>;
+declare function trackInterestInSearch(eventData: InterestInSearchProps): void;
+declare const passengersCreatedSchema: z.ZodObject<{
+	"Departure Arrival": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Destination": z.ZodString;
+	"Departure Destination Terminal": z.ZodString;
+	"Departure Line": z.ZodString;
+	"Departure Origin": z.ZodString;
+	"Departure Origin Terminal": z.ZodString;
+	"Departure Price": z.ZodNumber;
+	"Departure Route": z.ZodString;
+	"Departure Stops": z.ZodOptional<z.ZodNumber>;
+	"Departure Time": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Transporter": z.ZodString;
+	"Passenger Count": z.ZodNumber;
+	"Recommended Trip": z.ZodBoolean;
+	"Recommended Trip Type": z.ZodOptional<z.ZodString>;
+	Routes: z.ZodNumber;
+	Total: z.ZodNumber;
+	"Trip Length": z.ZodOptional<z.ZodNumber>;
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Departure Arrival": string;
+	"Departure Destination": string;
+	"Departure Destination Terminal": string;
+	"Departure Line": string;
+	"Departure Origin": string;
+	"Departure Origin Terminal": string;
+	"Departure Price": number;
+	"Departure Route": string;
+	"Departure Time": string;
+	"Departure Transporter": string;
+	"Passenger Count": number;
+	"Recommended Trip": boolean;
+	Routes: number;
+	Total: number;
+	"Departure Stops"?: number | undefined;
+	"Recommended Trip Type"?: string | undefined;
+	"Trip Length"?: number | undefined;
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Departure Arrival": string;
+	"Departure Destination": string;
+	"Departure Destination Terminal": string;
+	"Departure Line": string;
+	"Departure Origin": string;
+	"Departure Origin Terminal": string;
+	"Departure Price": number;
+	"Departure Route": string;
+	"Departure Time": string;
+	"Departure Transporter": string;
+	"Passenger Count": number;
+	"Recommended Trip": boolean;
+	Routes: number;
+	Total: number;
+	"Departure Stops"?: number | undefined;
+	"Recommended Trip Type"?: string | undefined;
+	"Trip Length"?: number | undefined;
+}>;
+export type PassengersCreatedProps = z.infer<typeof passengersCreatedSchema>;
+declare const paymentAttemptSchema: z.ZodObject<{
+	"Departure Arrival": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Destination": z.ZodString;
+	"Departure Destination Terminal": z.ZodString;
+	"Departure Line": z.ZodString;
+	"Departure Origin": z.ZodString;
+	"Departure Origin Terminal": z.ZodString;
+	"Departure Price": z.ZodNumber;
+	"Departure Route": z.ZodString;
+	"Departure Stop Cities": z.ZodOptional<z.ZodString>;
+	"Departure Stops": z.ZodOptional<z.ZodNumber>;
+	"Departure Time": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Transporter": z.ZodString;
+	"Passenger Count": z.ZodNumber;
+	"Payment Type": z.ZodString;
+	"Recommended Trip": z.ZodBoolean;
+	"Recommended Trip Type": z.ZodOptional<z.ZodString>;
+	Routes: z.ZodNumber;
+	Total: z.ZodNumber;
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Departure Arrival": string;
+	"Departure Destination": string;
+	"Departure Destination Terminal": string;
+	"Departure Line": string;
+	"Departure Origin": string;
+	"Departure Origin Terminal": string;
+	"Departure Price": number;
+	"Departure Route": string;
+	"Departure Time": string;
+	"Departure Transporter": string;
+	"Passenger Count": number;
+	"Recommended Trip": boolean;
+	Routes: number;
+	Total: number;
+	"Payment Type": string;
+	"Departure Stops"?: number | undefined;
+	"Recommended Trip Type"?: string | undefined;
+	"Departure Stop Cities"?: string | undefined;
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Departure Arrival": string;
+	"Departure Destination": string;
+	"Departure Destination Terminal": string;
+	"Departure Line": string;
+	"Departure Origin": string;
+	"Departure Origin Terminal": string;
+	"Departure Price": number;
+	"Departure Route": string;
+	"Departure Time": string;
+	"Departure Transporter": string;
+	"Passenger Count": number;
+	"Recommended Trip": boolean;
+	Routes: number;
+	Total: number;
+	"Payment Type": string;
+	"Departure Stops"?: number | undefined;
+	"Recommended Trip Type"?: string | undefined;
+	"Departure Stop Cities"?: string | undefined;
+}>;
+export type PaymentAttemptProps = z.infer<typeof paymentAttemptSchema>;
+declare const pickedDepartureSchema: z.ZodObject<{
+	Arrival: z.ZodEffects<z.ZodString, string, string>;
+	Departure: z.ZodEffects<z.ZodString, string, string>;
+	Destination: z.ZodString;
+	"Destination Terminal": z.ZodString;
+	Line: z.ZodOptional<z.ZodString>;
+	Origin: z.ZodString;
+	"Origin Terminal": z.ZodString;
+	Price: z.ZodNumber;
+	"Result Position": z.ZodNumber;
+	Route: z.ZodString;
+	Stops: z.ZodNumber;
+	"Transport Type": z.ZodString;
+	Transporter: z.ZodString;
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+	"Recommended Trip": z.ZodEffects<z.ZodBoolean, boolean, boolean>;
+	"Recommended Trip Type": z.ZodEffects<z.ZodUnion<[
+		z.ZodString,
+		z.ZodNull
+	]>, string | null, string | null>;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Recommended Trip": boolean;
+	"Recommended Trip Type": string | null;
+	Arrival: string;
+	Departure: string;
+	Destination: string;
+	"Destination Terminal": string;
+	Origin: string;
+	"Origin Terminal": string;
+	Price: number;
+	"Result Position": number;
+	Route: string;
+	Stops: number;
+	"Transport Type": string;
+	Transporter: string;
+	Line?: string | undefined;
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Recommended Trip": boolean;
+	"Recommended Trip Type": string | null;
+	Arrival: string;
+	Departure: string;
+	Destination: string;
+	"Destination Terminal": string;
+	Origin: string;
+	"Origin Terminal": string;
+	Price: number;
+	"Result Position": number;
+	Route: string;
+	Stops: number;
+	"Transport Type": string;
+	Transporter: string;
+	Line?: string | undefined;
+}>;
+export type PickedDepartureProps = z.infer<typeof pickedDepartureSchema>;
+declare function trackSearch(eventData: PickedDepartureProps): void;
+declare const purchaseAttemptSchema: z.ZodObject<{
+	"Departure Arrival": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Destination": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Destination Terminal": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Line": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Origin": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Origin Terminal": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Price": z.ZodEffects<z.ZodNumber, number, number>;
+	"Departure Route": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Stops": z.ZodEffects<z.ZodNumber, number, number>;
+	"Departure Time": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Transport Type": z.ZodEffects<z.ZodString, string, string>;
+	"Departure Transporter": z.ZodEffects<z.ZodString, string, string>;
+	"Passenger Count": z.ZodEffects<z.ZodNumber, number, number>;
+	"Recommended Trip": z.ZodEffects<z.ZodBoolean, boolean, boolean>;
+	"Recommended Trip Type": z.ZodOptional<z.ZodEffects<z.ZodUnion<[
+		z.ZodString,
+		z.ZodNull
+	]>, string | null, string | null>>;
+	Routes: z.ZodEffects<z.ZodNumber, number, number>;
+	Total: z.ZodEffects<z.ZodNumber, number, number>;
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+	"Trip Length": z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Departure Arrival": string;
+	"Departure Destination": string;
+	"Departure Destination Terminal": string;
+	"Departure Line": string;
+	"Departure Origin": string;
+	"Departure Origin Terminal": string;
+	"Departure Price": number;
+	"Departure Route": string;
+	"Departure Stops": number;
+	"Departure Time": string;
+	"Departure Transporter": string;
+	"Passenger Count": number;
+	"Recommended Trip": boolean;
+	Routes: number;
+	Total: number;
+	"Departure Transport Type": string;
+	"Recommended Trip Type"?: string | null | undefined;
+	"Trip Length"?: number | undefined;
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	"Departure Arrival": string;
+	"Departure Destination": string;
+	"Departure Destination Terminal": string;
+	"Departure Line": string;
+	"Departure Origin": string;
+	"Departure Origin Terminal": string;
+	"Departure Price": number;
+	"Departure Route": string;
+	"Departure Stops": number;
+	"Departure Time": string;
+	"Departure Transporter": string;
+	"Passenger Count": number;
+	"Recommended Trip": boolean;
+	Routes: number;
+	Total: number;
+	"Departure Transport Type": string;
+	"Recommended Trip Type"?: string | null | undefined;
+	"Trip Length"?: number | undefined;
+}>;
+export type PurchaseAttemptProps = z.infer<typeof purchaseAttemptSchema>;
+declare function trackSearch$1(eventData: PurchaseAttemptProps): void;
+declare const searchSchema: z.ZodObject<{
+	Departure: z.ZodEffects<z.ZodString, string, string>;
+	"Departure Delta": z.ZodNumber;
+	Destination: z.ZodString;
+	"Destination Terminal": z.ZodString;
+	Origin: z.ZodString;
+	"Origin Terminal": z.ZodString;
+	Passengers: z.ZodNumber;
+	Return: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+	Route: z.ZodString;
+	"Trip Length": z.ZodOptional<z.ZodNumber>;
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	Departure: string;
+	Destination: string;
+	"Destination Terminal": string;
+	Origin: string;
+	"Origin Terminal": string;
+	Route: string;
+	"Departure Delta": number;
+	Passengers: number;
+	"Trip Length"?: number | undefined;
+	Return?: string | undefined;
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	Departure: string;
+	Destination: string;
+	"Destination Terminal": string;
+	Origin: string;
+	"Origin Terminal": string;
+	Route: string;
+	"Departure Delta": number;
+	Passengers: number;
+	"Trip Length"?: number | undefined;
+	Return?: string | undefined;
+}>;
+export type SearchProps = z.infer<typeof searchSchema>;
+declare function trackSearch$2(eventData: SearchProps): void;
+declare const seatChangeSchema: z.ZodObject<{
+	Arrival: z.ZodEffects<z.ZodString, string, string>;
+	Departure: z.ZodEffects<z.ZodString, string, string>;
+	Destination: z.ZodString;
+	"Destination Terminal": z.ZodString;
+	Line: z.ZodOptional<z.ZodString>;
+	Origin: z.ZodString;
+	"Origin Terminal": z.ZodString;
+	Price: z.ZodNumber;
+	Route: z.ZodString;
+	Stops: z.ZodOptional<z.ZodNumber>;
+	Tickets: z.ZodNumber;
+	Transporter: z.ZodString;
+	Way: z.ZodEnum<[
+		"Departure",
+		"Return"
+	]>;
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	Arrival: string;
+	Departure: string;
+	Destination: string;
+	"Destination Terminal": string;
+	Origin: string;
+	"Origin Terminal": string;
+	Price: number;
+	Route: string;
+	Transporter: string;
+	Tickets: number;
+	Way: "Departure" | "Return";
+	Line?: string | undefined;
+	Stops?: number | undefined;
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	Arrival: string;
+	Departure: string;
+	Destination: string;
+	"Destination Terminal": string;
+	Origin: string;
+	"Origin Terminal": string;
+	Price: number;
+	Route: string;
+	Transporter: string;
+	Tickets: number;
+	Way: "Departure" | "Return";
+	Line?: string | undefined;
+	Stops?: number | undefined;
+}>;
+export type SeatChangeProps = z.infer<typeof seatChangeSchema>;
+declare const viewResultsSchema: z.ZodObject<{
+	"Bus count": z.ZodNumber;
+	Departure: z.ZodEffects<z.ZodString, string, string>;
+	"Departure Delta": z.ZodOptional<z.ZodNumber>;
+	Destination: z.ZodOptional<z.ZodString>;
+	"Destination Terminal": z.ZodOptional<z.ZodString>;
+	"Has Frequent Buses": z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+	Origin: z.ZodString;
+	"Origin Terminal": z.ZodString;
+	Route: z.ZodString;
+	product: z.ZodEffects<z.ZodEnum<[
+		"web",
+		"web-mobile",
+		"ios",
+		"android",
+		"app"
+	]>, "web" | "web-mobile" | "ios" | "android" | "app", "web" | "web-mobile" | "ios" | "android" | "app">;
+}, "strip", z.ZodTypeAny, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	Departure: string;
+	Origin: string;
+	"Origin Terminal": string;
+	Route: string;
+	"Bus count": number;
+	Destination?: string | undefined;
+	"Destination Terminal"?: string | undefined;
+	"Departure Delta"?: number | undefined;
+	"Has Frequent Buses"?: boolean | undefined;
+}, {
+	product: "web" | "web-mobile" | "ios" | "android" | "app";
+	Departure: string;
+	Origin: string;
+	"Origin Terminal": string;
+	Route: string;
+	"Bus count": number;
+	Destination?: string | undefined;
+	"Destination Terminal"?: string | undefined;
+	"Departure Delta"?: number | undefined;
+	"Has Frequent Buses"?: boolean | undefined;
+}>;
+export type ViewResultsProps = z.infer<typeof viewResultsSchema>;
+declare function trackViewResults(eventData: ViewResultsProps): void;
+declare const IdentifySchema: z.ZodObject<{
+	firstName: z.ZodOptional<z.ZodString>;
+	lastName: z.ZodOptional<z.ZodString>;
+	email: z.ZodOptional<z.ZodString>;
+	phone: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+	email?: string | undefined;
+	firstName?: string | undefined;
+	lastName?: string | undefined;
+	phone?: string | undefined;
+}, {
+	email?: string | undefined;
+	firstName?: string | undefined;
+	lastName?: string | undefined;
+	phone?: string | undefined;
+}>;
+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.
@@ -33,19 +491,26 @@ declare const InitConfigSchema: z.ZodObject<{
  * Configuration object for initializing the tracking library.
  */
 export type InitConfig = z.infer<typeof InitConfigSchema>;
-/**
- * Initializes the tracking library with the provided configuration.
- * @param {InitConfig} config - The configuration object for initialization.
- * @throws {Error} Throws an error if the configuration is invalid.
- */
-export declare function init(config: InitConfig): Promise<void>;
-declare const tracker: {
+declare function init(config: InitConfig): Promise<void>;
+declare const analytics: {
 	init: typeof init;
-	trackTest: typeof trackTest;
+	identify: typeof identify;
+	track: {
+		test: typeof trackTest;
+		search: typeof trackSearch$2;
+		seatChange: (eventProps: SeatChangeProps) => Promise<void>;
+		interestInHome: typeof trackInterestInHome;
+		interestInSearch: typeof trackInterestInSearch;
+		viewResults: typeof trackViewResults;
+		passengersCreated: (eventProps: PassengersCreatedProps) => Promise<void>;
+		paymentAttempt: (eventProps: PaymentAttemptProps) => Promise<void>;
+		purchaseAttempt: typeof trackSearch$1;
+		pickedDeparture: typeof trackSearch;
+	};
 };
 
 export {
-	tracker as default,
+	analytics as default,
 };
 
 export {};