@reservamos/browser-analytics 1.0.7 → 1.0.10-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservamos/browser-analytics",
-  "version": "1.0.7",
+  "version": "1.0.10-alpha.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/reservamos/reservamos-browser-analytics.git"
@@ -88,6 +88,6 @@
     "upgradeps": "^2.0.6",
     "vite": "^5.0.12",
     "vitest": "^1.2.1",
-    "@reservamos/js-api-client": "5.26.0"
+    "@reservamos/js-api-client": "6.0.0-alpha.5"
   }
 }

package/src/events/customEvent/trackCustomEvent.ts

@@ -18,7 +18,7 @@ function trackCustomEvent(
     trackEvent(eventName, eventData, meta);
   } catch (error) {
     console.error('Error trackCustomEvent:', error);
-    trackEventError(eventName, error);
+    trackEventError(eventName, error, eventData);
   }
 }
 

package/src/events/identify/identify.ts

@@ -1,5 +1,5 @@
-import { getApiConfig } from '@/init';
 import createAnonymousProfile from '@/profiles/createAnonymousProfile';
+import configService from '@/services/config';
 import geolocationService from '@/services/geolocation';
 import validatorService from '@/services/validator';
 import { trackEventError, tryTrackEvent } from '@/track';
@@ -53,7 +53,6 @@ const identifyWithLocation = async (
   properties: UserProperties,
 ) => {
   try {
-    const apiConfig = getApiConfig();
     const coordinates = geolocationService.getCoordinates();
 
     if (!coordinates) {
@@ -69,12 +68,13 @@ const identifyWithLocation = async (
     delete properties.firstName;
     delete properties.lastName;
 
-    fetch(`${apiConfig?.coreUrl}/${apiConfig?.coreVersion}/datalake/identify`, {
+    const coreApiConfig = configService.getCoreAPIConfig();
+    fetch(`${coreApiConfig.baseUrl}/v1/datalake/identify`, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        'Authorization': apiConfig?.coreApiKey || '',
-        ...(apiConfig?.headers || {}),
+        'Authorization': coreApiConfig.defaultHeaders?.Authorization || '',
+        'Origin': coreApiConfig.defaultHeaders?.Origin || '',
       },
       body: JSON.stringify({
         profile_params: {
@@ -99,8 +99,8 @@ async function identify(
   userId: string,
   properties: UserProperties = {},
 ): Promise<void> {
-  try {
-    tryTrackEvent('Identify', async () => {
+  tryTrackEvent(async () => {
+    try {
       validatorService.parseIdentifyProps(properties);
 
       if (!userId) {
@@ -118,13 +118,13 @@ async function identify(
       if (fingerprint) {
         mixpanelService.attachProperty(FINGERPRINT_PROPERTY, fingerprint);
       }
-    });
-  } catch (error) {
-    console.error('Error identifying user', error);
-    trackEventError('Identify', error);
-  } finally {
-    identifyWithLocation(userId, properties);
-  }
+    } catch (error) {
+      console.error('Error identifying user', error);
+      trackEventError('Identify', error, { userId, properties });
+    } finally {
+      identifyWithLocation(userId, properties);
+    }
+  });
 }
 
 export default identify;

package/src/index.ts

@@ -10,7 +10,10 @@ 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 { CreateRecommendedSeatsSchemaProps } from '@/recommendations/createRecommendedSeats';
+import type { GetRecommendedSeatsSchemaProps } from '@/recommendations/getRecommendedSeats';
 import type { EventData, EventMetadata } from '@/types/eventData';
+import type { GetRecommendedTripsProps } from '@/recommendations/getRecommendedTrips';
 import trackCustomEvent from '@/events/customEvent';
 import identify from '@/events/identify';
 import trackInterestInHome from '@/events/interestInHome';
@@ -19,15 +22,18 @@ import trackPassengersCreated from '@/events/passengersCreated';
 import trackPaymentAttempt from '@/events/paymentAttempt';
 import trackPickedDeparture from '@/events/pickedDeparture';
 import trackPurchaseAttempt from '@/events/purchaseAttempt';
+import trackPurchaseCanceled from '@/events/purchaseCanceled';
 import trackSearch from '@/events/search';
 import trackSeatChange from '@/events/seatChange';
 import trackViewResults from '@/events/viewResults';
 import init, { isTrackerReady } from '@/init';
 import createAnonymousProfile from '@/profiles/createAnonymousProfile';
+import createRecommendedSeats from '@/recommendations/createRecommendedSeats';
+import getRecommendedPlaces from '@/recommendations/getRecommendedPlaces';
+import getRecommendedSeats from '@/recommendations/getRecommendedSeats';
+import getRecommendedTrips from '@/recommendations/getRecommendedTrips';
 import fingerprintService from '@/services/fingerprint';
 import mixpanelService from '@/services/mixpanel';
-import './js-api-client.d.ts';
-import trackPurchaseCanceled from './events/purchaseCanceled/trackPurchaseCanceled.js';
 
 const analytics = {
   init,
@@ -40,6 +46,12 @@ const analytics = {
   profiles: {
     createAnonymousProfile,
   },
+  recommendations: {
+    getRecommendedPlaces,
+    createRecommendedSeats,
+    getRecommendedSeats,
+    getRecommendedTrips,
+  },
   track: {
     search: trackSearch,
     seatChange: trackSeatChange,
@@ -70,6 +82,9 @@ export type {
   EventMetadata,
   EventData,
   PurchaseCanceledProps,
+  GetRecommendedSeatsSchemaProps,
+  CreateRecommendedSeatsSchemaProps,
+  GetRecommendedTripsProps,
 };
 
 export default analytics;

package/src/init.ts

@@ -1,4 +1,4 @@
-import { setConfig as setApiConfig } from '@reservamos/js-api-client';
+import coreApi from '@reservamos/js-api-client/core';
 import { z } from 'zod';
 import configService from '@/services/config';
 import fingerprintService from '@/services/fingerprint';
@@ -21,15 +21,6 @@ function onLoaded() {
   window.dispatchEvent(new CustomEvent('Tracker Ready'));
 }
 
-interface ApiConfig {
-  coreUrl: string;
-  coreVersion: string;
-  headers: { Origin: string };
-  coreApiKey: string;
-}
-
-let apiConfig: ApiConfig | null = null;
-
 /**
  * Initializes the tracking library with the provided configuration.
  * @param {InitConfig} config - The configuration object for initialization.
@@ -60,10 +51,8 @@ async function init(config: InitConfig) {
     console.error('Error initializing identification service:', error);
   }
 
-  const environment = isSandbox ? 'sandbox' : 'prod';
-  apiConfig = configService.coreAPIConfig[environment];
-
-  setApiConfig(apiConfig);
+  configService.setEnvironment(isSandbox ? 'sandbox' : 'prod');
+  coreApi.setConfig(configService.getCoreAPIConfig());
 
   // Dispatch the 'Tracker Ready' event
   onLoaded();
@@ -79,12 +68,5 @@ function isTrackerReady(): boolean {
   return mixpanelService.isReady();
 }
 
-/**
- * Returns the current API configuration.
- * @returns {ApiConfig | null} The current API configuration or null if not initialized.
- */
-function getApiConfig(): ApiConfig | null {
-  return apiConfig;
-}
-export { isTrackerReady, getApiConfig };
+export { isTrackerReady };
 export default init;

package/src/profiles/createAnonymousProfile/createAnonymousProfile.ts

@@ -1,31 +1,20 @@
+import type {
+  AnonymousIdentifier,
+  AnonymousProfile,
+  CreateAnonymousProfilePayload,
+  IdentifierKey,
+} from '@reservamos/js-api-client/core';
 import type { CreateAnonymousProfileProps } from './createAnonymousProfileSchema';
-import { core as coreApi } from '@reservamos/js-api-client';
+import coreApi from '@reservamos/js-api-client/core';
 import fingerprintService from '@/services/fingerprint';
 import mixpanelService from '@/services/mixpanel';
 import validatorService from '@/services/validator';
 import CreateAnonymousProfileSchema from './createAnonymousProfileSchema';
 
-type IdentifierKey = 'phone' | 'email';
-
-interface AnonymousProfilePayload {
-  identifier_key: IdentifierKey;
-  identifier_value: string;
-  identifiers: AnonymousIdentifier[];
-  details: Record<string, string>;
-}
-interface AnonymousProfileResponse {
-  id: string;
-}
-/**
- * Transforms the identifier object based on the provided values.
- * @param {CreateAnonymousProfileProps} values - The values to transform.
- * @param {AnonymousIdentifier[]} identifiersProps - Additional identifiers to include.
- * @returns {AnonymousProfilePayload} The transformed identifier object.
- */
 function getAnonymousProfilePayload(
   values: CreateAnonymousProfileProps,
   identifiersProps: AnonymousIdentifier[],
-): AnonymousProfilePayload {
+): CreateAnonymousProfilePayload {
   let identifier_key: IdentifierKey = 'phone';
   let identifier_value: string = values.phone || '';
   const identifiers: AnonymousIdentifier[] = [];
@@ -65,19 +54,9 @@ function getAnonymousProfilePayload(
   };
 }
 
-interface AnonymousIdentifier {
-  key: string;
-  value: string;
-}
-
-/**
- * Creates an anonymous profile using the provided payload.
- * @param {CreateAnonymousProfileProps} payload - The payload to create the anonymous profile.
- * @returns {Promise<void>} - A promise that resolves when the anonymous profile is created.
- */
 async function createAnonymousProfile(
   payload: CreateAnonymousProfileProps,
-): Promise<AnonymousProfileResponse | undefined> {
+): Promise<AnonymousProfile | undefined> {
   try {
     validatorService.validateProps(payload, CreateAnonymousProfileSchema);
 
@@ -90,9 +69,7 @@ async function createAnonymousProfile(
     if (distinctId) identifiers.push({ key: 'distinct_id', value: distinctId });
 
     const dataPayload = getAnonymousProfilePayload(payload, identifiers);
-
-    const result = await coreApi.createAnonymousProfile(dataPayload);
-    return result.data;
+    return await coreApi.profiles.createAnonymousProfile(dataPayload);
   } catch (error) {
     console.error('Could not create anonymous profile:', error);
     return undefined;

package/src/recommendations/createRecommendedSeats/createRecommendedSeats.ts

@@ -0,0 +1,40 @@
+import type {
+  RecommendedSeatsPayload,
+  RecommendedSeatsResponse,
+} from '@reservamos/js-api-client/core';
+import coreApi from '@reservamos/js-api-client/core';
+import fingerprintService from '@/services/fingerprint';
+import mixpanelService from '@/services/mixpanel';
+import validatorService from '@/services/validator';
+import CreateRecommendedSeatsSchema from './createRecommendedSeatsSchema';
+
+/**
+ * Creates recommended seats by combining the provided payload with user identification data
+ * from Mixpanel and Fingerprint services.
+ * @throws {Error} When no distinct ID is found
+ * @throws {Error} When payload validation fails
+ * @throws {Error} When the API request fails
+ */
+async function createRecommendedSeats(
+  payload: RecommendedSeatsPayload,
+): Promise<RecommendedSeatsResponse> {
+  try {
+    validatorService.validateProps(payload, CreateRecommendedSeatsSchema);
+    const distinctId = mixpanelService.getMixpanelDistinctId();
+    const userFingerprintId = fingerprintService.getCachedFingerprint();
+    if (!distinctId) {
+      throw new Error('No distinct ID found');
+    }
+
+    return await coreApi.recommendations.createRecommendedSeats({
+      ...payload,
+      distinct_id: distinctId,
+      device_fingerprint: userFingerprintId || '',
+    });
+  } catch (error) {
+    console.error('Could not create recommended seats:', error);
+    throw new Error(error instanceof Error ? error.message : String(error));
+  }
+}
+
+export default createRecommendedSeats;

package/src/recommendations/createRecommendedSeats/createRecommendedSeatsSchema.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+
+const SeatSchema = z.object({
+  category: z.string(),
+  number: z.string().optional(),
+  occupied: z.boolean().optional(),
+  adjacent_seats: z.null().optional(),
+});
+
+const BusSchemeSchema = z.object({
+  bus: z.array(z.array(z.array(SeatSchema))),
+});
+
+const CreateRecommendedSeatsSchema = z.object({
+  bus_type: z.string(),
+  selected_seats: z.string(),
+  bus_scheme: BusSchemeSchema,
+});
+
+type CreateRecommendedSeatsSchemaProps = z.infer<
+  typeof CreateRecommendedSeatsSchema
+>;
+
+export type { CreateRecommendedSeatsSchemaProps };
+export default CreateRecommendedSeatsSchema;

package/src/recommendations/createRecommendedSeats/index.ts

@@ -0,0 +1,5 @@
+import type { CreateRecommendedSeatsSchemaProps } from './createRecommendedSeatsSchema';
+import createRecommendedSeats from './createRecommendedSeats';
+
+export type { CreateRecommendedSeatsSchemaProps };
+export default createRecommendedSeats;

package/src/recommendations/getRecommendedPlaces/getRecommendedPlaces.ts

@@ -0,0 +1,63 @@
+import type { RecommendedPlacesResponse } from '@reservamos/js-api-client/core';
+import coreApi from '@reservamos/js-api-client/core';
+import mixpanelService from '@/services/mixpanel';
+
+/**
+ * Polls the recommended places API until a final state is reached
+ * @throws Will reject the promise if the polling status returns 'failed'
+ * @private
+ */
+const pollingRecommendedPlaces = async (
+  response: RecommendedPlacesResponse,
+) => {
+  return new Promise((resolve, reject) => {
+    const { state, polling_id } = response;
+    if (state === 'finished') {
+      resolve(response);
+      return;
+    }
+    coreApi.recommendations.pollRecommendedPlaces(polling_id, {
+      start: true,
+      watch: 'state',
+      expect: 'finished',
+      onEachResponse: (profile) => {
+        if (profile.status === 'finished') {
+          resolve(profile);
+          return;
+        }
+        if (profile.status === 'failed') {
+          reject(profile);
+          return;
+        }
+      },
+    });
+  });
+};
+
+/**
+ * Fetches personalized place recommendations for a user
+ * This function retrieves recommended places based on the user's Mixpanel distinct ID.
+ * It initiates the recommendation process and polls until the results are ready.
+ * @returns {Promise<RecommendedPlacesResponse>} A promise that resolves with the recommended places
+ * @throws {Error} When no Mixpanel distinct ID is found
+ * @throws {Error} When no response is received from the recommendations API
+ */
+async function getRecommendedPlaces(): Promise<RecommendedPlacesResponse> {
+  const distinctId = mixpanelService.getMixpanelDistinctId();
+  if (!distinctId) {
+    throw new Error('No distinct ID found');
+  }
+
+  const response = await coreApi.recommendations.createRecommendedPlaces({
+    distinct_id: distinctId,
+  });
+
+  if (!response) {
+    throw new Error('No response received');
+  }
+
+  const profile = await pollingRecommendedPlaces(response);
+  return profile as RecommendedPlacesResponse;
+}
+
+export default getRecommendedPlaces;

package/src/recommendations/getRecommendedPlaces/index.ts

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

package/src/recommendations/getRecommendedSeats/getRecommendedSeats.ts

@@ -0,0 +1,37 @@
+import type {
+  GetRecommendedSeatsPayload,
+  GetRecommendedSeatsResponse,
+} from '@reservamos/js-api-client/core';
+import coreApi from '@reservamos/js-api-client/core';
+import mixpanelService from '@/services/mixpanel';
+import validatorService from '@/services/validator';
+import GetRecommendedSeatsSchema from './getRecommendedSeatsSchema';
+
+/**
+ * Create recommended seats by combining the provided payload with data from
+ * user identification from Mixpanel and Fingerprint services.
+ * @throws {Error} When the payload fails schema validation
+ * @throws {Error} When no Mixpanel distinct ID is found
+ * @throws {Error} When the API request fails
+ */
+async function createRecommendedSeats(
+  payload: GetRecommendedSeatsPayload,
+): Promise<GetRecommendedSeatsResponse> {
+  try {
+    validatorService.validateProps(payload, GetRecommendedSeatsSchema);
+    const distinctId = mixpanelService.getMixpanelDistinctId();
+    if (!distinctId) {
+      throw new Error('No distinct ID found');
+    }
+
+    return await coreApi.recommendations.getRecommendedSeats({
+      ...payload,
+      distinct_id: distinctId,
+    });
+  } catch (error) {
+    console.error('Could not create recommended seats:', error);
+    throw new Error(error instanceof Error ? error.message : String(error));
+  }
+}
+
+export default createRecommendedSeats;

package/src/recommendations/getRecommendedSeats/getRecommendedSeatsSchema.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+
+const SeatSchema = z.object({
+  category: z.string(),
+  number: z.string().optional(),
+  occupied: z.boolean().optional(),
+  adjacent_seats: z.null().optional(),
+});
+
+const BusSchemeSchema = z.object({
+  bus: z.array(z.array(z.array(SeatSchema))),
+});
+
+const GetRecommendedSeatsSchema = z.object({
+  bus_scheme: BusSchemeSchema,
+  total_seats: z.number()
+});
+
+type GetRecommendedSeatsSchemaProps = z.infer<
+  typeof GetRecommendedSeatsSchema
+>;
+
+export type { GetRecommendedSeatsSchemaProps };
+export default GetRecommendedSeatsSchema;

package/src/recommendations/getRecommendedSeats/index.ts

@@ -0,0 +1,5 @@
+import type { GetRecommendedSeatsSchemaProps } from './getRecommendedSeatsSchema';
+import getRecommendedSeats from './getRecommendedSeats';
+
+export type { GetRecommendedSeatsSchemaProps };
+export default getRecommendedSeats;

package/src/recommendations/getRecommendedTrips/getRecommendedTrips.ts

@@ -0,0 +1,36 @@
+import type {
+  RecommendedTripsResponse,
+  GetRecommendedTripsPayload
+} from '@reservamos/js-api-client/core';
+import coreApi from '@reservamos/js-api-client/core';
+import fingerprintService from '@/services/fingerprint';
+import mixpanelService from '@/services/mixpanel';
+import validatorService from '@/services/validator';
+import GetRecommendedTripsSchema from './getRecommendedTripsSchema';
+
+/**
+ * Fetches recommended trips based on the provided search ID.
+ * @throws Error if user identifier is not loaded correctly or if the api request fails
+ */
+async function getRecommendedTrips({
+  searchId,
+}: GetRecommendedTripsPayload): Promise<RecommendedTripsResponse> {
+  try {
+    validatorService.validateProps({ searchId }, GetRecommendedTripsSchema);
+    const identifier =
+      fingerprintService.getCachedFingerprint() ||
+      mixpanelService.getMixpanelDistinctId();
+    if (!identifier) throw new Error('No identifier id');
+
+    const response = await coreApi.recommendations.getRecommendedTrips({
+      searchId,
+      userIdentifier: String(identifier),
+    });
+    return response;
+  } catch (error) {
+    console.error('Could not get recommended trips:', error);
+    throw new Error(error instanceof Error ? error.message : String(error));
+  }
+}
+
+export default getRecommendedTrips;

package/src/recommendations/getRecommendedTrips/getRecommendedTripsSchema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+
+const GetRecommendedTripsSchema = z.object({
+  searchId: z.number().min(1, 'SearchId is required'),
+});
+
+type GetRecommendedTripsProps = z.infer<typeof GetRecommendedTripsSchema>;
+
+export type { GetRecommendedTripsProps };
+export default GetRecommendedTripsSchema;

package/src/recommendations/getRecommendedTrips/index.ts

@@ -0,0 +1,5 @@
+import type { GetRecommendedTripsProps } from './getRecommendedTripsSchema';
+import getRecommendedTrips from './getRecommendedTrips';
+
+export type { GetRecommendedTripsProps };
+export default getRecommendedTrips;

package/src/services/config.ts

@@ -1,26 +1,49 @@
+import type { ApiConfig } from '@reservamos/js-api-client/core';
+
+type AvailableEnvironments = 'sandbox' | 'prod';
+
+let environment: AvailableEnvironments | undefined;
 const origin = window.location.origin;
 
-const coreAPIConfig = {
+type CoreAPIConfig = Record<AvailableEnvironments, ApiConfig>;
+
+const coreAPIConfig: CoreAPIConfig = {
   sandbox: {
-    coreUrl: 'https://datalake-api-dev.reservamossaas.com/api',
-    coreVersion: 'v1',
-    headers: {
+    baseUrl: 'https://datalake-api-dev.reservamossaas.com/api',
+    defaultHeaders: {
       Origin: origin,
+      Authorization: 'Bearer 753bf0710dc920a84236d42241d4f487',
     },
-    coreApiKey: 'Bearer 753bf0710dc920a84236d42241d4f487'
   },
   prod: {
-    coreUrl: 'https://data-lake.reservamossaas.com/api',
-    coreVersion: 'v1',
-    headers: {
+    baseUrl: 'https://data-lake.reservamossaas.com/api',
+    defaultHeaders: {
       Origin: origin,
+      Authorization: 'Bearer 753bf0710dc920a84236d42241d4f487',
     },
-    coreApiKey:'Bearer 753bf0710dc920a84236d42241d4f487'
   },
 };
 
+function setEnvironment(env: AvailableEnvironments) {
+  environment = env;
+}
+
+/**
+ * Returns the core API config for the current environment.
+ * @throws {Error} Throws an error if the environment is not set.
+ */
+function getCoreAPIConfig(): ApiConfig {
+  if (!environment) {
+    throw new Error(
+      'Unable to get core API config, environment not set. Use configService.setEnvironment(environment) to set the environment.',
+    );
+  }
+  return coreAPIConfig[environment];
+}
+
 const configService = {
-  coreAPIConfig,
+  setEnvironment,
+  getCoreAPIConfig,
 };
 
 export default configService;

package/src/services/mixpanel.ts

@@ -1,4 +1,5 @@
 import mixpanel from 'mixpanel-browser';
+import { version } from '../../package.json';
 
 declare global {
   interface Window {
@@ -79,8 +80,7 @@ function track(eventName: string, properties: Record<string, unknown>): void {
   if (!isReady()) {
     return;
   }
-
-  mixpanel.track(eventName, properties);
+  mixpanel.track(eventName, { ...properties, 'Reservamos Version': version });
 }
 
 /**