@reservamos/browser-analytics 0.2.2 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservamos/browser-analytics",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/reservamos/reservamos-browser-analytics.git"

package/src/events/customEvent/trackCustomEvent.ts

@@ -1,19 +1,25 @@
+import type { EventData, EventMetadata } from '@/types/eventData';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 import { eventNameSchema } from './customEventSchema';
 
 /**
  * Tracks a custom event with any event name, data, and metadata.
  * @param {string} eventName - The name of the custom event.
  * @param {EventData} eventData - Additional data to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
-function trackCustomEvent(eventName: string, eventData: EventData = {}): void {
+function trackCustomEvent(
+  eventName: string,
+  eventData: EventData = {},
+  meta: EventMetadata = {},
+): void {
   try {
     eventNameSchema.parse(eventName);
-    trackEvent(eventName, eventData);
+    trackEvent(eventName, eventData, meta);
   } catch (error) {
     console.error('Error trackCustomEvent:', error);
     return;
   }
 }
+
 export default trackCustomEvent;

package/src/events/interestInHome/trackInterestInHome.ts

@@ -1,17 +1,17 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { InterestInHomeProps } from './interestInHomeSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'Interest In Home';
 
 /**
  * Tracks a Interest In Home event.
  * @param {InterestInHomeProps} eventData - The data associated with the Interest In Home event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
 function trackInterestInHome(
   eventData: InterestInHomeProps,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): void {
   trackEvent(EVENT_NAME, eventData, meta);
 }

package/src/events/interestInSearch/trackInterestInSearch.ts

@@ -1,17 +1,17 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { InterestInSearchProps } from './interestInSearchSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'Interest In Search';
 
 /**
  * Tracks a Interest In Search event.
  * @param {InterestInSearchProps} eventData - The data associated with the Interest In Search event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
 function trackInterestInSearch(
   eventData: InterestInSearchProps,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): void {
   trackEvent(EVENT_NAME, eventData, meta);
 }

package/src/events/passengersCreated/trackPassengersCreated.ts

@@ -1,17 +1,17 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { PassengersCreatedProps } from './passengersCreatedSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'Passengers Created';
 
 /**
  * Tracks a Passengers Created event.
  * @param {PassengersCreatedProps} eventProps - The data associated with the Passengers Created event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
 function trackPassengersCreated(
   eventProps: PassengersCreatedProps,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): void {
   trackEvent(EVENT_NAME, eventProps, meta);
 }

package/src/events/paymentAttempt/trackPaymentAttempt.ts

@@ -1,10 +1,14 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { PaymentAttemptProps } from './paymentAttemptSchema';
 import { trackEvent } from '@/track';
 
 const EVENT_NAME = 'Payment Attempt';
 
-const trackPaymentAttempt = async (eventProps: PaymentAttemptProps) => {
-  trackEvent(EVENT_NAME, eventProps);
+const trackPaymentAttempt = async (
+  eventProps: PaymentAttemptProps,
+  meta: EventMetadata = {},
+) => {
+  trackEvent(EVENT_NAME, eventProps, meta);
 };
 
 export default trackPaymentAttempt;

package/src/events/pickedDeparture/trackPickedDeparture.ts

@@ -1,17 +1,17 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { PickedDepartureProps } from './pickedDepartureSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'Picked Departure';
 
 /**
  * Tracks a Picked Departure event.
  * @param {PickedDepartureProps} eventData - The data associated with the Picked Departure event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
 function trackSearch(
   eventData: PickedDepartureProps,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): void {
   trackEvent(EVENT_NAME, eventData, meta);
 }

package/src/events/purchaseAttempt/trackPurchaseAttempt.ts

@@ -1,17 +1,17 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { PurchaseAttemptProps } from './purchaseAttemptSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'Purchase Attempt';
 
 /**
  * Tracks a Purchase Attempt event.
  * @param {PurchaseAttemptProps} eventData - The data associated with the Purchase Attempt event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
 function trackPurchaseAttempt(
   eventData: PurchaseAttemptProps,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): void {
   trackEvent(EVENT_NAME, eventData, meta);
 }

package/src/events/search/trackSearch.ts

@@ -1,15 +1,15 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { SearchProps } from './searchSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'Search';
 
 /**
  * Tracks a search event.
  * @param {SearchProps} eventData - The data associated with the search event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
-function trackSearch(eventData: SearchProps, meta: EventData = {}): void {
+function trackSearch(eventData: SearchProps, meta: EventMetadata = {}): void {
   trackEvent(EVENT_NAME, eventData, meta);
 }
 

package/src/events/seatChange/trackSeatChange.ts

@@ -1,17 +1,17 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { SeatChangeProps } from './seatChangeSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'Seat Change';
 
 /**
  * Tracks a Seat Change event.
  * @param {SeatChangeProps} eventProps - The data associated with the Seat Change event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
 function trackSeatChange(
   eventProps: SeatChangeProps,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): void {
   trackEvent(EVENT_NAME, eventProps, meta);
 }

package/src/events/viewResults/trackViewResults.ts

@@ -1,17 +1,17 @@
+import type { EventMetadata } from '@/types/eventData';
 import type { ViewResultsProps } from './viewResultsSchema';
 import { trackEvent } from '@/track';
-import EventData from '@/types/eventData';
 
 const EVENT_NAME = 'View Results';
 
 /**
  * Tracks a View Results event.
  * @param {ViewResultsProps} eventData - The data associated with the View Results event.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  */
 function trackViewResults(
   eventData: ViewResultsProps,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): void {
   trackEvent(EVENT_NAME, eventData, meta);
 }

package/src/index.ts

@@ -9,6 +9,7 @@ import type { SearchProps } from '@/events/search';
 import type { SeatChangeProps } from '@/events/seatChange';
 import type { ViewResultsProps } from '@/events/viewResults';
 import type { CreateAnonymousProfileProps } from '@/profiles/createAnonymousProfile';
+import type { EventData, EventMetadata } from '@/types/eventData';
 import trackCustomEvent from '@/events/customEvent';
 import identify from '@/events/identify';
 import trackInterestInHome from '@/events/interestInHome';
@@ -19,9 +20,8 @@ import trackPickedDeparture from '@/events/pickedDeparture';
 import trackPurchaseAttempt from '@/events/purchaseAttempt';
 import trackSearch from '@/events/search';
 import trackSeatChange from '@/events/seatChange';
-import trackTest from '@/events/test';
 import trackViewResults from '@/events/viewResults';
-import { init } from '@/init';
+import init, { isTrackerReady } from '@/init';
 import createAnonymousProfile from '@/profiles/createAnonymousProfile';
 import fingerprintService from '@/services/fingerprint';
 import mixpanelService from '@/services/mixpanel';
@@ -29,6 +29,7 @@ import './js-api-client.d.ts';
 
 const analytics = {
   init,
+  isReady: isTrackerReady,
   identify,
   identifiers: {
     getFingerprintId: fingerprintService.getCachedFingerprint,
@@ -38,7 +39,6 @@ const analytics = {
     createAnonymousProfile,
   },
   track: {
-    test: trackTest,
     search: trackSearch,
     seatChange: trackSeatChange,
     interestInHome: trackInterestInHome,
@@ -64,5 +64,8 @@ export type {
   PickedDepartureProps,
   CustomEventProps,
   CreateAnonymousProfileProps,
+  EventMetadata,
+  EventData,
 };
+
 export default analytics;

package/src/init.ts

@@ -3,7 +3,7 @@ import { z } from 'zod';
 import configService from '@/services/config';
 import fingerprintService from '@/services/fingerprint';
 import mixpanelService from '@/services/mixpanel';
-import validator, { InitConfigSchema } from './services/validator';
+import validator, { InitConfigSchema } from '@/services/validator';
 
 /**
  * Configuration object for initializing the tracking library.
@@ -25,7 +25,7 @@ function onLoaded() {
  * @param {InitConfig} config - The configuration object for initialization.
  * @throws {Error} Throws an error if the configuration is invalid.
  */
-export async function init(config: InitConfig) {
+async function init(config: InitConfig) {
   validator.parseInitProps(config);
 
   const {
@@ -64,6 +64,9 @@ export async function init(config: InitConfig) {
  * This function verifies whether the Mixpanel tracker has been initialized and is ready to use.
  * @returns {boolean} Returns true if the Mixpanel tracker is ready, otherwise false.
  */
-export function isTrackerReady(): boolean {
+function isTrackerReady(): boolean {
   return mixpanelService.isReady();
 }
+
+export { isTrackerReady };
+export default init;

package/src/services/validator.ts

@@ -30,7 +30,7 @@ export 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.
    */

package/src/track.ts

@@ -1,7 +1,11 @@
+import type {
+  AllowedPrimitive,
+  EventData,
+  EventMetadata,
+} from './types/eventData';
 import fingerprintService from '@/services/fingerprint';
 import mixpanelService from '@/services/mixpanel';
 import validator from '@/services/validator';
-import EventData, { AllowedPrimitive } from './types/eventData';
 
 /**
  * List of events that trigger the fingerprint to be sent with the event. other events will only fetch the cached fingerprint.
@@ -43,13 +47,13 @@ function flattenEventData(data: object): EventData {
  * This function adds default properties like User Fingerprint.
  * @param {string} eventName - The name of the event to track.
  * @param {object} eventProperties - The properties of the event to track.
- * @param {EventData} meta - Additional metadata to include in the event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
  * @throws {Error} Throws an error if Mixpanel or Fingerprint is not ready.
  */
 export async function trackEvent(
   eventName: string,
   eventProperties: object,
-  meta: EventData = {},
+  meta: EventMetadata = {},
 ): Promise<void> {
   if (!mixpanelService.isReady()) {
     throw new Error('Mixpanel is not initialized.');

package/src/types/eventData.ts

@@ -1,5 +1,7 @@
-export type AllowedPrimitive = string | boolean | number | undefined;
+type AllowedPrimitive = string | boolean | number | undefined;
 
 type EventData = Record<string, AllowedPrimitive | AllowedPrimitive[]>;
 
-export default EventData;
+type EventMetadata = EventData;
+
+export type { EventData, AllowedPrimitive, EventMetadata };

package/src/events/test/index.ts

@@ -1,3 +0,0 @@
-import trackTest from './trackTest';
-
-export default trackTest;

package/src/events/test/trackTest.ts

@@ -1,12 +0,0 @@
-import { trackEvent } from '@/track';
-
-const EVENT_NAME = 'Track Test';
-
-/**
-  First test event to track, it purpose is to test the tracking library and the identification service.ws
- */
-function trackTest() {
-  trackEvent(EVENT_NAME, {});
-}
-
-export default trackTest;