Merge pull request #14 from peek-travel/feat/booking-source-details

feat: add sourceDetails to bookings from initialQuote actor name

Author: oskarbruening

docs/webhooks.md

@@ -46,7 +46,7 @@ the full price breakdown, so one registration captures everything; the parser
 auto-detects whatever a given payload carries.
 
 ```
-{ displayId id primaryGuest { name email phone optinMarketing optinSms isGdpr postalCode } activitySnapshot { type name id } ticketQuantities { quantity resourceOptionSnapshot { name id } } reservationStatus checkinStatus returnStatus fulfillmentStatusOverride { status } timeSnapshot { id legacyId } purchasedAt purchasedAtUtc startsAt startsAtUtc endsAt endsAtUtc availabilityTimeId bookingPortalUrl operatorNotes value { convenienceFee { amount formatted } deposit { amount formatted } discount { amount formatted } discountedPrice { amount formatted } fees { amount formatted } flatPartnerFee { amount formatted } price { amount formatted } retailPrice { amount formatted } taxes { amount formatted } tips { amount formatted } total { formatted amount } } balance { total { amount formatted } } tips { price { amount formatted } } order { displayId id promoCodes { code } channelSnapshot { id name agent { name } } initialQuote { source { actor { app } } } } questionAnswers { answer questionText questionLocationSnapshot { latitude longitude } } tickets { questionAnswers { answer questionText } } resourcePoolAssignments { quantity resourcePool { name shortName resources { name } } resourceAssignments { resource { id name } } } bookingGuests { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } primaryGuest { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } }
+{ displayId id primaryGuest { name email phone optinMarketing optinSms isGdpr postalCode } activitySnapshot { type name id } ticketQuantities { quantity resourceOptionSnapshot { name id } } reservationStatus checkinStatus returnStatus fulfillmentStatusOverride { status } timeSnapshot { id legacyId } purchasedAt purchasedAtUtc startsAt startsAtUtc endsAt endsAtUtc availabilityTimeId bookingPortalUrl operatorNotes value { convenienceFee { amount formatted } deposit { amount formatted } discount { amount formatted } discountedPrice { amount formatted } fees { amount formatted } flatPartnerFee { amount formatted } price { amount formatted } retailPrice { amount formatted } taxes { amount formatted } tips { amount formatted } total { formatted amount } } balance { total { amount formatted } } tips { price { amount formatted } } order { displayId id promoCodes { code } channelSnapshot { id name agent { name } } initialQuote { source { actor { app name } } } } questionAnswers { answer questionText questionLocationSnapshot { latitude longitude } } tickets { questionAnswers { answer questionText } } resourcePoolAssignments { quantity resourcePool { name shortName resources { name } } resourceAssignments { resource { id name } } } bookingGuests { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } primaryGuest { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } }
 ```
 
 > This package owns this string internally and snapshots it in

src/internal/bookings/booking-converter.ts

@@ -68,6 +68,7 @@ export function fromBookingNode(
   const data = node ?? {};
   const ticketQuantities = data.ticketQuantities ?? [];
   const app = data.order?.initialQuote?.source?.actor?.app ?? null;
+  const sourceDetails = data.order?.initialQuote?.source?.actor?.name ?? null;
 
   const customQuestionAnswers: CustomQuestionAnswer[] = (data.questionAnswers ?? []).map(
     (answer) => {
@@ -101,6 +102,7 @@ export function fromBookingNode(
     source: sourceFromApp(app),
     sourceApp: app || UNKNOWN,
     sourceDescription: sourceDescriptionFromApp(app),
+    sourceDetails,
 
     customerName: data.primaryGuest?.name || "",
     customerEmail: data.primaryGuest?.email || null,

src/internal/bookings/booking-queries.ts

@@ -122,6 +122,7 @@ export const bookingQueryFields = `
       source {
         actor {
           app
+          name
         }
       }
     }
@@ -514,7 +515,9 @@ export interface BookingNode {
     id?: string;
     promoCodes?: Array<{ code: string }>;
     channelSnapshot?: { id?: string; name?: string; agent?: { name?: string } | null } | null;
-    initialQuote?: { source?: { actor?: { app?: string } | null } | null } | null;
+    initialQuote?: {
+      source?: { actor?: { app?: string; name?: string } | null } | null;
+    } | null;
   } | null;
   questionAnswers?: Array<{
     answer: string;

src/models/booking.ts

@@ -139,6 +139,11 @@ export interface Booking {
    * `"unknown"` when the origin can't be mapped.
    */
   sourceDescription: string;
+  /**
+   * Raw source actor name reported by Peek, when present. `null` when the
+   * origin actor carries no name.
+   */
+  sourceDetails: string | null;
 
   /** Primary guest's name, or `""` when unknown. */
   customerName: string | null;

test/bookings/booking-converter.test.ts

@@ -63,7 +63,7 @@ function fullNode(): BookingNode {
       id: "o_1",
       promoCodes: [{ code: "SUMMER" }],
       channelSnapshot: { id: "ch-1", name: "Acme", agent: { name: "Jane" } },
-      initialQuote: { source: { actor: { app: "WIDGET" } } },
+      initialQuote: { source: { actor: { app: "WIDGET", name: "Acme Widget" } } },
     },
     questionAnswers: [
       {
@@ -113,6 +113,7 @@ describe("fromBookingNode", () => {
     expect(booking.source).toBe("website");
     expect(booking.sourceApp).toBe("WIDGET");
     expect(booking.sourceDescription).toBe("Website Booking Flow");
+    expect(booking.sourceDetails).toBe("Acme Widget");
     expect(booking.customerName).toBe("Ada");
     expect(booking.isRentalProduct).toBe(true);
     expect(booking.timeslotId).toBe("legacy-ts");
@@ -168,6 +169,7 @@ describe("fromBookingNode", () => {
       source: "unknown",
       sourceApp: "unknown",
       sourceDescription: "unknown",
+      sourceDetails: null,
       customerName: "",
       customerEmail: null,
       productId: "unknown",
@@ -203,6 +205,7 @@ describe("fromBookingNode", () => {
     expect(booking.source).toBe("unknown");
     expect(booking.sourceDescription).toBe("unknown");
     expect(booking.sourceApp).toBe("NOT_A_SOURCE");
+    expect(booking.sourceDetails).toBe(null);
     expect(booking.isRentalProduct).toBe(false);
   });
 

test/bookings/booking-webhook.test.ts

@@ -14,7 +14,7 @@ import type { BookingNode } from "../../src/internal/bookings/booking-queries.js
  * if it is accidental, this catches it before release.
  */
 const REGISTERED_WEBHOOK_QUERY =
-  "{ displayId id primaryGuest { name email phone optinMarketing optinSms isGdpr postalCode } activitySnapshot { type name id } ticketQuantities { quantity resourceOptionSnapshot { name id } } reservationStatus checkinStatus returnStatus fulfillmentStatusOverride { status } timeSnapshot { id legacyId } purchasedAt purchasedAtUtc startsAt startsAtUtc endsAt endsAtUtc availabilityTimeId bookingPortalUrl operatorNotes value { convenienceFee { amount formatted } deposit { amount formatted } discount { amount formatted } discountedPrice { amount formatted } fees { amount formatted } flatPartnerFee { amount formatted } price { amount formatted } retailPrice { amount formatted } taxes { amount formatted } tips { amount formatted } total { formatted amount } } balance { total { amount formatted } } tips { price { amount formatted } } order { displayId id promoCodes { code } channelSnapshot { id name agent { name } } initialQuote { source { actor { app } } } } questionAnswers { answer questionText questionLocationSnapshot { latitude longitude } } tickets { questionAnswers { answer questionText } } resourcePoolAssignments { quantity resourcePool { name shortName resources { name } } resourceAssignments { resource { id name } } } bookingGuests { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } primaryGuest { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } }";
+  "{ displayId id primaryGuest { name email phone optinMarketing optinSms isGdpr postalCode } activitySnapshot { type name id } ticketQuantities { quantity resourceOptionSnapshot { name id } } reservationStatus checkinStatus returnStatus fulfillmentStatusOverride { status } timeSnapshot { id legacyId } purchasedAt purchasedAtUtc startsAt startsAtUtc endsAt endsAtUtc availabilityTimeId bookingPortalUrl operatorNotes value { convenienceFee { amount formatted } deposit { amount formatted } discount { amount formatted } discountedPrice { amount formatted } fees { amount formatted } flatPartnerFee { amount formatted } price { amount formatted } retailPrice { amount formatted } taxes { amount formatted } tips { amount formatted } total { formatted amount } } balance { total { amount formatted } } tips { price { amount formatted } } order { displayId id promoCodes { code } channelSnapshot { id name agent { name } } initialQuote { source { actor { app name } } } } questionAnswers { answer questionText questionLocationSnapshot { latitude longitude } } tickets { questionAnswers { answer questionText } } resourcePoolAssignments { quantity resourcePool { name shortName resources { name } } resourceAssignments { resource { id name } } } bookingGuests { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } primaryGuest { id name country dateOfBirth email isGdpr isParticipant optinSms optinMarketing phone postalCode fieldResponses { id text fieldLocation { field { name } } } } }";
 
 function webhookNode(): BookingNode {
   return {