@reservamos/browser-analytics 1.0.9 → 1.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservamos/browser-analytics",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "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": "6.0.0-alpha.2"
+    "@reservamos/js-api-client": "6.0.0-alpha.5"
   }
 }

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,14 +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 trackPurchaseCanceled from './events/purchaseCanceled/trackPurchaseCanceled.js';
 
 const analytics = {
   init,
@@ -39,6 +46,12 @@ const analytics = {
   profiles: {
     createAnonymousProfile,
   },
+  recommendations: {
+    getRecommendedPlaces,
+    createRecommendedSeats,
+    getRecommendedSeats,
+    getRecommendedTrips,
+  },
   track: {
     search: trackSearch,
     seatChange: trackSeatChange,
@@ -69,6 +82,9 @@ export type {
   EventMetadata,
   EventData,
   PurchaseCanceledProps,
+  GetRecommendedSeatsSchemaProps,
+  CreateRecommendedSeatsSchemaProps,
+  GetRecommendedTripsProps,
 };
 
 export default analytics;

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/geolocation.ts

@@ -9,23 +9,55 @@ interface Coordinates {
 
 // Add state to store coordinates
 let currentCoordinates: Coordinates | null = null;
+
+// Constants for local storage keys and time limits
+const GEOLOCATION_PERMISSION_KEY = 'geolocationPermissionTimestamp';
+const SEVEN_DAYS_IN_MS = 7 * 24 * 60 * 60 * 1000;
+
+/**
+ * Checks if the geolocation permission timestamp is still valid.
+ * @param {string | null} lastPermissionTimestamp - The last permission timestamp from local storage.
+ * @returns {boolean} True if the timestamp is valid, false otherwise.
+ */
+function isPermissionTimestampValid(
+  lastPermissionTimestamp: string | null,
+): boolean {
+  if (!lastPermissionTimestamp) return false;
+  const now = Date.now();
+  return now - parseInt(lastPermissionTimestamp, 10) < SEVEN_DAYS_IN_MS;
+}
+
+/**
+ * Updates the geolocation permission timestamp in local storage.
+ * @param {number} timestamp - The current timestamp to store.
+ */
+function updatePermissionTimestamp(timestamp: number): void {
+  localStorage.setItem(GEOLOCATION_PERMISSION_KEY, timestamp.toString());
+}
+
 /**
  * Initializes geolocation service and retrieves user coordinates
  * @returns {Promise<Coordinates | null>} Promise resolving to coordinates or null if geolocation fails/is denied
  */
 function init(): Promise<Coordinates | null> {
   return new Promise((resolve) => {
-    if (currentCoordinates) {
+    const lastPermissionTimestamp = localStorage.getItem(
+      GEOLOCATION_PERMISSION_KEY,
+    );
+
+    if (isPermissionTimestampValid(lastPermissionTimestamp)) {
       resolve(currentCoordinates);
       return;
     }
 
     const GEOLOCATION_TRACK_EVENT = 'Geolocation Requested';
+    const now = Date.now();
 
     navigator.geolocation.getCurrentPosition(
       (geolocation) => {
         const { latitude: lat, longitude: long } = geolocation.coords;
         currentCoordinates = { lat, long };
+        updatePermissionTimestamp(now);
         if (isTrackerReady()) {
           trackCustomEvent(GEOLOCATION_TRACK_EVENT, {
             geolocationAccepted: true,
@@ -34,6 +66,7 @@ function init(): Promise<Coordinates | null> {
         resolve(currentCoordinates);
       },
       () => {
+        updatePermissionTimestamp(now);
         if (isTrackerReady()) {
           trackCustomEvent(GEOLOCATION_TRACK_EVENT, {
             geolocationAccepted: false,