@reservamos/browser-analytics 1.1.3 → 1.1.5-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservamos/browser-analytics",
-  "version": "1.1.3",
+  "version": "1.1.5-alpha.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/reservamos/reservamos-browser-analytics.git"
@@ -39,6 +39,10 @@
   ],
   "license": "MIT",
   "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
   "scripts": {
     "dev": "vite --host",
     "prebuild": "rm -rf dist/*",

package/src/events/purchaseConfirmation/index.ts

@@ -0,0 +1,7 @@
+import type { PurchaseConfirmationProps } from './purchaseConfirmationSchema';
+import purchaseConfirmationSchema from './purchaseConfirmationSchema';
+import trackPurchaseConfirmation from './trackPurchaseConfirmation';
+
+export type { PurchaseConfirmationProps };
+export { purchaseConfirmationSchema };
+export default trackPurchaseConfirmation;

package/src/events/purchaseConfirmation/purchaseConfirmation.test.ts

@@ -0,0 +1,102 @@
+import { describe, expect, it, vi } from 'vitest';
+import purchaseConfirmationSchema from './purchaseConfirmationSchema';
+
+const trackEventMock = vi.fn();
+
+vi.mock('@/track', () => ({
+  trackEvent: (...args: unknown[]) => trackEventMock(...args),
+}));
+
+describe('purchaseConfirmationSchema', () => {
+  it('accepts a valid confirmed payload', () => {
+    const payload = {
+      order_number: 'MOB-123',
+      payment_status: 'confirmed',
+    };
+
+    expect(purchaseConfirmationSchema.parse(payload)).toEqual(payload);
+  });
+
+  it('accepts a valid pending_pix payload with optional fields', () => {
+    const payload = {
+      order_number: 'MOB-123',
+      payment_status: 'pending_pix',
+      payment_type: 'pix',
+      total: 199.9,
+    };
+
+    expect(purchaseConfirmationSchema.parse(payload)).toEqual(payload);
+  });
+
+  it('rejects a payload missing order_number', () => {
+    expect(() =>
+      purchaseConfirmationSchema.parse({ payment_status: 'confirmed' }),
+    ).toThrow();
+  });
+
+  it('rejects a payload missing payment_status', () => {
+    expect(() =>
+      purchaseConfirmationSchema.parse({ order_number: 'MOB-123' }),
+    ).toThrow();
+  });
+
+  it('rejects an invalid payment_status value', () => {
+    expect(() =>
+      purchaseConfirmationSchema.parse({
+        order_number: 'MOB-123',
+        payment_status: 'refunded',
+      }),
+    ).toThrow();
+  });
+
+  it('rejects unknown fields', () => {
+    expect(() =>
+      purchaseConfirmationSchema.parse({
+        order_number: 'MOB-123',
+        payment_status: 'confirmed',
+        extra_field: 'not allowed',
+      }),
+    ).toThrow();
+  });
+});
+
+describe('trackPurchaseConfirmation', () => {
+  it('sends the Purchase Confirmation Viewed event with the given data and meta', async () => {
+    trackEventMock.mockClear();
+    const trackPurchaseConfirmation = (await import('./trackPurchaseConfirmation'))
+      .default;
+
+    const eventData = {
+      order_number: 'MOB-123',
+      payment_status: 'confirmed' as const,
+    };
+    const meta = { source: 'checkout' };
+
+    trackPurchaseConfirmation(eventData, meta);
+
+    expect(trackEventMock).toHaveBeenCalledWith(
+      'Purchase Confirmation Viewed',
+      eventData,
+      meta,
+    );
+  });
+
+  it('defaults meta to an empty object when not provided', async () => {
+    trackEventMock.mockClear();
+    const trackPurchaseConfirmation = (await import('./trackPurchaseConfirmation'))
+      .default;
+
+    const eventData = {
+      order_number: 'MOB-456',
+      payment_status: 'pending_pix' as const,
+    };
+
+    trackPurchaseConfirmation(eventData);
+
+    expect(trackEventMock).toHaveBeenCalledWith(
+      'Purchase Confirmation Viewed',
+      eventData,
+      {},
+    );
+  });
+});

package/src/events/purchaseConfirmation/purchaseConfirmationSchema.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+const purchaseConfirmationSchema = z
+  .object({
+    order_number: z.string().min(1, 'order_number is required'),
+    payment_status: z.enum(['confirmed', 'pending_pix']),
+    payment_type: z.string().optional(),
+    total: z.number().optional(),
+  })
+  .strict();
+
+type PurchaseConfirmationProps = z.infer<typeof purchaseConfirmationSchema>;
+
+export type { PurchaseConfirmationProps };
+export default purchaseConfirmationSchema;

package/src/events/purchaseConfirmation/trackPurchaseConfirmation.ts

@@ -0,0 +1,19 @@
+import type { EventMetadata } from '@/types/eventData';
+import type { PurchaseConfirmationProps } from './purchaseConfirmationSchema';
+import { trackEvent } from '@/track';
+
+const EVENT_NAME = 'Purchase Confirmation Viewed';
+
+/**
+ * Tracks a Purchase Confirmation Viewed event.
+ * @param {PurchaseConfirmationProps} eventData - The data associated with the Purchase Confirmation Viewed event.
+ * @param {EventMetadata} meta - Additional metadata to include in the event.
+ */
+function trackPurchaseConfirmation(
+  eventData: PurchaseConfirmationProps,
+  meta: EventMetadata = {},
+): void {
+  trackEvent(EVENT_NAME, eventData, meta);
+}
+
+export default trackPurchaseConfirmation;

package/src/index.ts

@@ -7,6 +7,7 @@ import type { PaymentAttemptProps } from '@/events/paymentAttempt';
 import type { PickedDepartureProps } from '@/events/pickedDeparture';
 import type { PurchaseAttemptProps } from '@/events/purchaseAttempt';
 import type { PurchaseCanceledProps } from '@/events/purchaseCanceled';
+import type { PurchaseConfirmationProps } from '@/events/purchaseConfirmation';
 import type { SearchProps } from '@/events/search';
 import type { SeatChangeProps } from '@/events/seatChange';
 import type { ViewResultsProps } from '@/events/viewResults';
@@ -27,6 +28,7 @@ import trackPaymentAttempt from '@/events/paymentAttempt';
 import trackPickedDeparture from '@/events/pickedDeparture';
 import trackPurchaseAttempt from '@/events/purchaseAttempt';
 import trackPurchaseCanceled from '@/events/purchaseCanceled';
+import trackPurchaseConfirmation from '@/events/purchaseConfirmation';
 import trackSearch from '@/events/search';
 import trackSeatChange from '@/events/seatChange';
 import trackViewResults from '@/events/viewResults';
@@ -75,6 +77,7 @@ const analytics = {
     customEvent: trackCustomEvent,
     purchaseCanceled: trackPurchaseCanceled,
     geolocationSelected: trackGeolocationSelected,
+    purchaseConfirmation: trackPurchaseConfirmation,
   },
 };
 
@@ -99,6 +102,7 @@ export type {
   CreateFrequentPassengersSchemaProps,
   DeleteFrequentPassengerProps,
   GeolocationSelectedProps,
+  PurchaseConfirmationProps,
 };
 
 export default analytics;

package/src/services/validator/validator.ts

@@ -8,6 +8,7 @@ import { passengersCreatedSchema } from '@/events/passengersCreated';
 import { paymentAttemptSchema } from '@/events/paymentAttempt';
 import { pickedDepartureSchema } from '@/events/pickedDeparture';
 import { purchaseAttemptSchema } from '@/events/purchaseAttempt';
+import { purchaseConfirmationSchema } from '@/events/purchaseConfirmation';
 import { searchSchema } from '@/events/search';
 import { seatChangeSchema } from '@/events/seatChange';
 import { viewResultsSchema } from '@/events/viewResults';
@@ -101,6 +102,7 @@ const eventSchemas: Record<string, z.ZodSchema> = {
   'Purchase Attempt': purchaseAttemptSchema,
   'Picked Departure': pickedDepartureSchema,
   'Geolocation Selected': geolocationSelectedSchema,
+  'Purchase Confirmation Viewed': purchaseConfirmationSchema,
 };
 
 type EventDataSchema = z.infer<