@seeka-labs/cli-apps 3.7.0 → 3.8.2

package/dist/ai-context/internal/examples/v1/sevenrooms/src/lib/sevenrooms/models.ts

@@ -0,0 +1,193 @@
+import { SevenRoomsAppInstallSettings } from "../state/seeka/installations"
+
+export interface SevenRoomsWebhookPayload<TEntity> {
+    entity: TEntity,
+    entity_type: 'reservation' | 'client' | string,
+    event_type: 'updated' | 'created' | string,
+    updates: SevenRoomsWebhookPayloadUpdatedField[]
+}
+
+export interface SevenRoomsWebhookPayloadUpdatedField {
+    field: string
+    previous: any
+}
+
+export const getSevenRoomsApiHost = (installationSettings: SevenRoomsAppInstallSettings) => {
+    if (!installationSettings?.advanced?.sevenRoomsApiHost) return 'api.sevenrooms.com';
+
+    return installationSettings?.advanced?.sevenRoomsApiHost;
+}
+
+export interface ReservationPosTicket {
+    status: string
+    admin_fee: number
+    code: number
+    items: ReservationItem[]
+    table_no: string
+    tax: number
+    business_id: number
+    local_pos_ticket_id: string
+    ticket_id: number
+    employee_name: string
+    total: number
+    subtotal: number
+    start_time: string
+    service_charge: number
+    end_time: string
+}
+
+export interface ReservationItem {
+    price: number
+    name: string
+    quantity: number
+}
+
+export interface ReservationTag {
+    color: string
+    tag_display: string
+    group_display: string
+    group: string
+    tag: string
+}
+
+export interface SevenRoomsUser {
+    id: string
+    name: string
+}
+
+export interface SevenRoomsClient {
+    birthday_alt_day?: any
+    last_name?: string
+    client_tags?: SevenRoomsClientTag[]
+    photo?: SevenRoomsClientPhoto
+    external_user_id?: any
+    loyalty_rank?: number
+    anniversary_month?: any
+    birthday_day?: number
+    city?: string
+    title?: string
+    anniversary_day?: any
+    phone_number_locale?: string
+    total_spend_per_visit?: number
+    total_visits?: number
+    updated?: string
+    marketing_opt_in_ts?: string
+    company?: string
+    total_spend?: number
+    loyalty_id?: string
+    gender?: string
+    avg_rating?: number
+    has_billing_profile?: boolean
+    phone_number_alt?: string
+    is_one_time_guest?: boolean
+    address_2?: any
+    reference_code?: string
+    postal_code?: string
+    notes?: string
+    status?: string
+    phone_number_alt_locale?: string
+    marketing_opt_in?: boolean
+
+    // for create client payload only
+    venue_marketing_opt_in?: boolean
+
+    // for create client payload only
+    venue_id?: string
+
+    // for create client payload only
+    venue_group_marketing_opt_in?: boolean
+
+    salutation?: string
+    id?: string
+    custom_fields?: SevenRoomsClientCustomField[]
+    photo_crop_info?: SevenRoomsClientPhotoCropInfo
+    member_groups?: any[]
+    first_name?: string
+    total_cancellations?: number
+    is_contact_private?: boolean
+    birthday_alt_month?: any
+    email_alt?: string
+    venue_group_id?: string
+    state?: string
+    birthday_month?: number
+    total_covers?: number
+    email?: string
+    phone_number?: string
+    private_notes?: string
+    tags?: string
+    deleted?: any
+    total_spend_per_cover?: number
+    total_noshows?: number
+    user?: SevenRoomsUser
+    venue_stats?: { [key: string]: SevenRoomsClientVenueStats }
+    address?: string
+    created?: string
+    country?: string
+    loyalty_tier?: string
+}
+
+export interface SevenRoomsClientTag {
+    color: string
+    tag_display: string
+    group_display: string
+    group: string
+    tag: string
+}
+
+export interface SevenRoomsClientPhoto {
+    medium: string
+    large_height: number
+    small_width: number
+    medium_width: number
+    small_height: number
+    large: string
+    raw: string
+    medium_height: number
+    small: string
+    large_width: number
+}
+
+export interface SevenRoomsClientCustomField {
+    system_name: string
+    display_order: number
+    name: string
+    value: string
+}
+
+export interface SevenRoomsClientPhotoCropInfo {
+    y: number
+    x: number
+    height: number
+    width: number
+}
+
+
+export interface SevenRoomsClientVenueStats {
+    total_spend_local_per_cover?: number
+    last_visit_date?: string
+    total_cancellations?: number
+    total_covers?: number
+    avg_rating?: number
+    total_spend_per_cover?: number
+    total_spend?: number
+    booked_by_names?: string[]
+    total_noshows?: number
+    num_ratings?: number
+    total_spend_per_visit?: number
+    total_spend_local?: number
+    total_spend_local_per_visit?: number
+    total_visits?: number
+    gross_total?: number
+    total_order_count?: number
+    total_order_cancellations?: number
+    total_order_spend?: number
+    gross_order_total?: number
+    total_order_spend_local?: number
+    last_order_date?: any
+    total_spend_per_order?: number
+    total_spend_local_per_order?: number
+    venue_id: string
+    venue_marketing_opt_in?: boolean,
+    venue_marketing_opt_in_ts?: string,
+    venue_marketing_opt_out_ts?: string
+}

package/dist/ai-context/internal/examples/v1/sevenrooms/src/lib/sevenrooms/reservations/index.ts

@@ -0,0 +1,365 @@
+import { Logger } from "winston";
+import { SevenRoomsWebhookPayload, SevenRoomsUser, getSevenRoomsApiHost } from "../models";
+import { SeekaAppInstallState, SevenRoomsAppInstallSettings } from "../../../lib/state/seeka/installations";
+import { SevenRoomsAuthToken } from "../auth";
+import { ActivityPayload, CommerceActivityTrackingEventMetadata, CommerceActivityTrackingEventProductMetadata, SeekaActivityAcceptedWebhookContent, SeekaAppHelper, TrackingActivityNames, TrackingEventSourceOriginType, getActivityName, isValidSeekaProfileId } from "@seeka-labs/sdk-apps-server";
+import { name, version } from '../../../../package.json';
+import { sanitiseSevenRoomsPhoneNumber } from "../helpers";
+import { DateTime } from "luxon";
+
+export const handleSevenRoomsReservationWebhook = async (payload: SevenRoomsWebhookPayload<SevenRoomsReservation>, installation: SeekaAppInstallState, logger: Logger) => {
+    const reservation = payload.entity;
+    let thisLogger = logger.child({
+        reservationId: reservation.id,
+        reservationReference: reservation.reference_code,
+        clientReference: reservation.client_reference_code,
+        clientId: reservation.client_id,
+    });
+    thisLogger.debug('Received SevenRooms reservation webhook', { payload });
+
+    const previousStatus = payload.updates?.find(u => u.field === 'status')?.previous;
+    if (!previousStatus) {
+        thisLogger.verbose('No previous status found in SevenRooms reservation webhook, unchanged so not handling', { payload });
+        return;
+    }
+
+    if (!reservation) {
+        thisLogger.error('No reservation found in SevenRooms reservation webhook', { payload });
+        return;
+    }
+    const currentStatus = reservation.status;
+    const isArrived = currentStatus === 'ARRIVED_PARTIAL' || currentStatus === 'ARRIVED';
+    if (!isArrived) {
+        thisLogger.verbose('Reservation is not in arrived state, not handling', { payload });
+        return;
+    }
+
+    // Check if we have already fired a status change for either arrived or arrived partial
+    // Handling both status allows for SevenRooms customers to either use the arrived partial function or not
+    // and also allow for partial arrival to be handled as a full arrival
+    if (previousStatus === 'ARRIVED_PARTIAL') {
+        thisLogger.verbose('Already handled ARRIVED_PARTIAL status change, not handling ARRIVED status', { payload });
+        return;
+    }
+
+    const eventConfig = installation.installationSettings.events;
+    if (!eventConfig) {
+        thisLogger.error('No event configuration found in installation settings. Not handling SevenRooms reservation webhook', { installation });
+        return;
+    }
+
+    thisLogger.info('Handling SevenRooms reservation due to status change', { previousStatus, currentStatus });
+
+    const helper = SeekaAppHelper.create(process.env['SEEKA_APP_SECRET'] as string, {
+        organisationId: installation.organisationId as string,
+        applicationInstallId: installation.applicationInstallId as string,
+        applicationId: process.env['SEEKA_APP_ID'] as string,
+    }, { name, version }, installation.installationState.grantedPermissions, thisLogger);
+
+    // Get person ID
+    let existingSeekaPersonId: string | undefined = undefined;
+    if (isValidSeekaProfileId(reservation.external_client_id)) {
+        existingSeekaPersonId = reservation.external_client_id;
+        thisLogger = thisLogger.child({ 'Person_PersonId': existingSeekaPersonId });
+        thisLogger.verbose('Found existing Seeka person id in reservation - external_client_id');
+    }
+    else if (isValidSeekaProfileId(reservation.external_user_id)) {
+        existingSeekaPersonId = reservation.external_user_id;
+        thisLogger = thisLogger.child({ 'Person_PersonId': existingSeekaPersonId });
+        thisLogger.verbose('Found existing Seeka person id in reservation - external_user_id');
+    }
+    else {
+        existingSeekaPersonId = await helper.api.mergeIdentity({
+            email: [reservation.email],
+            phone: [sanitiseSevenRoomsPhoneNumber(reservation.phone_number)],
+            firstName: [reservation.first_name],
+            lastName: [reservation.last_name],
+        }, {
+            origin: TrackingEventSourceOriginType.Server
+        });
+        thisLogger = thisLogger.child({ 'Person_PersonId': existingSeekaPersonId });
+        thisLogger.info('Enriched Seeka identity for reservation');
+    }
+
+    // Get activity name
+    let activityName: TrackingActivityNames;
+    let activityNameCustom: string | undefined = undefined;
+
+    if (reservation.total_payment && reservation.total_payment > 0) {
+        activityName = getActivityName(eventConfig.reservationBookingArrivedWithValueEventName);
+        if (activityName == TrackingActivityNames.Custom) {
+            activityNameCustom = eventConfig.reservationBookingArrivedWithValueEventName;
+        }
+    }
+    else {
+        activityName = getActivityName(eventConfig.reservationBookingArrivedZeroValueEventName);
+        if (activityName == TrackingActivityNames.Custom) {
+            activityNameCustom = eventConfig.reservationBookingArrivedZeroValueEventName;
+        }
+    }
+
+    // Parse params
+    const commerce: CommerceActivityTrackingEventMetadata = {
+        totalPrice: reservation.onsite_payment_total || reservation.prepayment_total,
+        totalTax: reservation.onsite_payment_tax || reservation.prepayment_tax,
+        currencyCode: installation.installationState?.sevenRoomsVenue?.currencyCode,
+        orderIdentifier: reservation.id,
+        customerIdentifier: reservation.client_id
+    }
+    const product: CommerceActivityTrackingEventProductMetadata = {};
+    let productPopulated = false;
+    if (reservation.reservation_type) {
+        product.productName = reservation.reservation_type;
+        product.productIdentifier = product.productName;
+        productPopulated = true;
+    }
+    // else if (reservation.notes && reservation.notes.indexOf('Selected: ') > -1) {
+    //     // try and get product from notes
+    //     const notesParts = reservation.notes.split('Selected: ');
+    //     const second = notesParts[1];
+    //     if (second) {
+    //         const split = second.split(';');
+    //         if (split[0]) {
+    //             product.productName = split[0];
+    //             product.productIdentifier = product.productName;
+    //             productPopulated = true;
+    //         }
+    //     }
+    // }
+    if (productPopulated) {
+        product.unitPrice = commerce.totalPrice;
+        product.quantity = 1;
+        product.currencyCode = commerce.currencyCode;
+        commerce.products = [product];
+    }
+
+    const props: {
+        [key: string]: string;
+    } = {};
+
+    const timezone = installation.installationSettings.advanced?.sevenRoomsVenueTimezone;
+    props.bookingStart = reservation.date;
+    props.bookingEnd = reservation.date;
+
+    // reservation.date is alread in local venue timezone
+    props.bookingStartLocal = reservation.date;
+    props.bookingEndLocal = reservation.date;
+    if (timezone) {
+        props.timezone = timezone;
+    }
+    else {
+        thisLogger.warn('No timezone found in installation settings');
+    }
+
+    // Create payload
+    const params: ActivityPayload = {};
+    switch (activityName) {
+        case TrackingActivityNames.Order:
+        case TrackingActivityNames.SubscriptionItemPurchase:
+        case TrackingActivityNames.OneTimeItemPurchase:
+        case TrackingActivityNames.InitiateCheckout:
+        case TrackingActivityNames.AddPaymentMethod:
+            {
+                params.commerce = commerce;
+                break;
+            }
+        case TrackingActivityNames.Lead:
+            {
+                params.lead = {
+                    currencyCode: commerce.currencyCode,
+                    sourceContentName: commerce.products ? commerce.products[0].productName : undefined,
+                    predictedValue: commerce.totalPrice
+                }
+                break;
+            }
+        case TrackingActivityNames.Custom:
+        case TrackingActivityNames.ViewContentItem:
+        default:
+            {
+                params.contentItem = {
+                    currencyCode: commerce.currencyCode,
+                    value: commerce.totalPrice,
+                    items: commerce.products
+                }
+                break;
+            }
+    }
+
+    // Track activity
+    const completePayload = {
+        activityId: `sevenrooms-reservation-${(reservation.reference_code || reservation.id)}-arrived`,
+        activityName,
+        activityNameCustom,
+        properties: {
+            ...props
+        },
+        ...params
+    };
+    thisLogger.info('Tracking activity for reservation', { activityName, activityNameCustom, completePayload });
+    await helper.api.trackActivityForProfileId(completePayload, existingSeekaPersonId, {
+        origin: TrackingEventSourceOriginType.Server
+    });
+}
+
+export const findSevenRoomsReservations = async (sevenRoomsClientId: string, fromDate: DateTime, toDate: DateTime, installSettings: SevenRoomsAppInstallSettings, sevenRoomsToken: SevenRoomsAuthToken, logger: Logger): Promise<SevenRoomsReservation[]> => {
+    const params = {
+        venue_group_id: installSettings.connection.sevenRoomsVenueGroupId,
+        venue_id: installSettings.connection.sevenRoomsVenueId,
+        client_id: sevenRoomsClientId,
+        from_date: fromDate.toISO(),
+        to_date: toDate.toISO(),
+        limit: '10',
+        sort_order: 'spend_descending'
+    };
+
+    const response = await fetch(`https://${getSevenRoomsApiHost(installSettings)}/2_4/reservations?` + new URLSearchParams(params).toString(), {
+        method: 'GET',
+        headers: {
+            'Authorization': `${sevenRoomsToken.token}`
+        }
+    });
+
+    // TODO: handle multiple pages
+    if (response.ok) {
+        const result = (await response.json())?.data as SevenRoomsReservationSearchResponse;
+
+        return result.results;
+    }
+    else {
+        logger.error(`Failed to get reservations from SevenRooms: ${response.statusText}`, { res: await response.text(), status: response.status });
+        throw new Error(`Failed to get reservations from SevenRooms: ${response.statusText}`);
+    }
+}
+
+export const getReservationDateByActivity = (content: SeekaActivityAcceptedWebhookContent, logger: Logger): Date => {
+    let date = content.activity.time ? new Date(content.activity.time) : content.source.time ? new Date(content.source.time) : null;
+
+    if (!date) {
+        logger.error('No date found in activity for reservation date', { activity: content });
+        date = new Date();
+    }
+
+    return date;
+}
+
+export interface SevenRoomsReservationSearchResponse {
+    cursor: number
+    limit: number
+    results: SevenRoomsReservation[]
+}
+
+export interface SevenRoomsReservation {
+    rating: any
+    last_name: string
+    external_user_id: any
+    check_numbers: string
+    loyalty_rank: any
+    left_time: any
+    postal_code: any
+    city: any
+    mf_ratio_male: number
+    venue_id: string
+    venue_group_client_id: string
+    min_price: any
+    served_by: any
+    client_requests: any
+    updated: string
+    pos_tickets: any[]
+    mf_ratio_female: number
+    reservation_type: string
+    client_id: string
+    source_client_id: any
+    paid_by: any
+    loyalty_id: any
+    table_numbers: string[]
+    max_guests: number
+    notes: string
+    created: string
+    address_2: any
+    reference_code: string
+    cost_option: number
+    phone_number: string
+    external_reference_code: any
+    shift_persistent_id: string
+    status_simple: string
+    seated_time: any
+    duration: number
+    modify_reservation_link: string
+    id: string
+    first_name: string
+    arrived_guests: any
+    client_reference_code: string
+    venue_group_id: string
+    state: any
+    email: string
+    status: string
+    booked_by: string
+    tags: SevenRoomsReservationTag[]
+    deleted: any
+    comps: any
+    external_client_id: any
+    address: any
+    date: string
+    comps_price_type: any
+    shift_category: string
+    arrival_time: string
+    country: any
+    access_persistent_id: any
+    is_vip: boolean
+    status_display: string
+    external_id: any
+    loyalty_tier: any
+    user: SevenRoomsUser
+    auto_assignments: SevenRoomsReservationAutoAssignments
+    real_datetime_of_slot: string
+    time_slot_iso: string
+    venue_seating_area_name: string
+    venue_seating_area_id: any
+    prepayment: number
+    prepayment_total: number
+    prepayment_net: any
+    prepayment_service_charge: any
+    prepayment_tax: any
+    prepayment_gratuity: any
+    onsite_payment: any
+    onsite_payment_net: any
+    onsite_payment_tax: any
+    onsite_payment_gratuity: any
+    onsite_payment_total: number
+    total_payment: number
+    total_net_payment: number
+    total_gross_payment: number
+    using_default_duration: boolean
+    hotel_confirmation: any
+    hotel_id: any
+    hotel_room: any
+    upgrades: SevenRoomsReservationUpgrade[]
+    reservation_sms_opt_in: any
+    send_reminder_email: boolean
+    send_reminder_sms: boolean
+}
+
+export interface SevenRoomsReservationTag {
+    color: string
+    tag_display: string
+    group_display: string
+    group: string
+    tag: string
+}
+
+export interface SevenRoomsReservationAutoAssignments {
+    table_codes: string[]
+    sort_order: number
+    name: string
+    table_ids: string[]
+    is_reassigned: boolean
+}
+
+export interface SevenRoomsReservationUpgrade {
+    inventory_id: string
+    category_id: string
+    name: string
+    quantity: number
+    price: number
+    pos_item_id: string
+}

package/dist/ai-context/internal/examples/v1/sevenrooms/src/lib/sevenrooms/venues/index.ts

@@ -0,0 +1,54 @@
+import { Logger } from "winston"
+import { SevenRoomsAppInstallSettings } from "../../state/seeka/installations";
+import { getSevenRoomsApiHost } from "../models";
+import { SevenRoomsAuthToken } from "../auth";
+
+export const listSevenRoomsVenues = async (installSettings: SevenRoomsAppInstallSettings, sevenRoomsToken: SevenRoomsAuthToken, logger: Logger): Promise<SevenRoomsVenue[]> => {
+    const url = `https://${getSevenRoomsApiHost(installSettings)}/2_4/venues`;
+
+    const response = await fetch(url, {
+        method: 'GET',
+        headers: {
+            'Authorization': `${sevenRoomsToken.token}`
+        }
+    });
+
+    // TODO: handle multiple pages
+    if (response.ok) {
+        return (await response.json())?.data?.results as SevenRoomsVenue[];
+    }
+    else {
+        logger.error(`Failed to get venues from SevenRooms: ${response.statusText}`, { res: await response.text(), status: response.status });
+        throw new Error(`Failed to get venues from SevenRooms: ${response.statusText}`);
+    }
+}
+
+export interface SevenRoomsVenue {
+    id: string
+    venue_group_id: string
+    venue_group_name: string
+    venue_url_key: string
+    name: string
+    internal_name: string
+    unique_confirmation_prefix: string
+    external_venue_id: string
+    venue_class: string
+    grid_enabled: boolean
+    membership_enabled: boolean
+    full_dining_backend: boolean
+    address: string
+    // cross_street: any
+    neighborhood: string
+    municipality: string
+    municipality_id: string
+    postal_code: string
+    website: string
+    phone_number: string
+    // white_logo: WhiteLogo
+    // black_logo: BlackLogo
+    // photos: any[]
+    primary_color: string
+    secondary_color: string
+    policy: string
+    currency_code: string
+}