@roomstay/core 0.1.78 → 0.1.79-1

package/dist/types/AnalyticsEvents/IRoomstayEventData.type.d.ts

@@ -20,6 +20,16 @@ export interface IRoomstayBasketItem {
     averageNightlyRate: number;
     promoCode?: string;
 }
+/**
+ * Serialized representation of a BasketAddonRow for analytics events.
+ */
+export interface IRoomstayBasketAddonItem {
+    addonCode: string;
+    addonName: string;
+    quantity: number;
+    unitPrice: number;
+    totalPrice: number;
+}
 /**
  * Guest/user information for analytics events.
  * Used for Booking/Committed events where we have guest details.
@@ -36,17 +46,25 @@ export interface IRoomstayGuestData {
     externalId?: string;
 }
 /**
- * Event data for Basket/Add event
+ * Event data for Basket/Add event (room added to cart)
  */
 export interface IRoomstayBasketAddEventData {
     item: IRoomstayBasketItem;
     currency: string;
 }
+/**
+ * Event data for Basket/AddAddon event (addon added to cart)
+ */
+export interface IRoomstayAddonAddEventData {
+    addon: IRoomstayBasketAddonItem;
+    currency: string;
+}
 /**
  * Event data for View/Checkout event
  */
 export interface IRoomstayCheckoutViewEventData {
     items: IRoomstayBasketItem[];
+    addons?: IRoomstayBasketAddonItem[];
     currency: string;
     totalValue: number;
 }
@@ -55,6 +73,7 @@ export interface IRoomstayCheckoutViewEventData {
  */
 export interface IRoomstayBookingCommittedEventData {
     items: IRoomstayBasketItem[];
+    addons?: IRoomstayBasketAddonItem[];
     currency: string;
     totalValue: number;
     roomstayId: string;
@@ -62,4 +81,10 @@ export interface IRoomstayBookingCommittedEventData {
     reservationNumbers: string[];
     guest: IRoomstayGuestData;
 }
-export type IRoomstayEventData = IRoomstayBasketAddEventData | IRoomstayCheckoutViewEventData | IRoomstayBookingCommittedEventData;
+export type IRoomstayEventData = IRoomstayBasketAddEventData | IRoomstayAddonAddEventData | IRoomstayCheckoutViewEventData | IRoomstayBookingCommittedEventData;
+/**
+ * Generic type for any event data that includes guest information.
+ */
+export interface IRoomstayEventDataWithGuest {
+    guest: IRoomstayGuestData;
+}

package/dist/types/AnalyticsEvents/MetaCapiTransformer.d.ts

@@ -4,7 +4,7 @@
  * Transforms Roomstay event data to Meta CAPI format.
  * Used both client-side (for Meta Pixel) and server-side (for Meta CAPI).
  */
-import { ERoomstayEventName, IMetaEventData, IMetaUserData } from './IAnalyticsEvent.type';
+import { ERoomstayEventName, IMetaEventData, IMetaPixelEventOptions, IMetaUserData } from './IAnalyticsEvent.type';
 import { IRoomstayEventData, IRoomstayGuestData } from './IRoomstayEventData.type';
 /**
  * Maps Roomstay event names to Meta CAPI event names
@@ -12,10 +12,14 @@ import { IRoomstayEventData, IRoomstayGuestData } from './IRoomstayEventData.typ
 export declare function toMetaEventName(eventName: ERoomstayEventName): string;
 /**
  * Transform roomstay event to Meta pixel/CAPI event.
- * Note: ViewBookingEngine events should not be transformed - they are for session init only.
  */
 export declare function transformToMetaEventData(eventData: IRoomstayEventData): IMetaEventData;
 /**
  * Transform guest data to Meta user_data format.
  */
 export declare function transformToMetaUserData(guest: IRoomstayGuestData): IMetaUserData;
+/**
+ * Build Meta Pixel options object with user data.
+ * Meta Pixel automatically hashes the user data values.
+ */
+export declare function buildPixelEventOptions(eventId: string, userData?: IMetaUserData): IMetaPixelEventOptions;

package/dist/types/{types/Api/Reservations.type.d.ts → Api/ReservationsDTO.d.ts}

@@ -1,14 +1,37 @@
-import { EBookingPaymentMethod, IPaymentCheckoutDetails } from '../Booking/IBookingPayment.type';
-import { SimpleItemisedFee } from '../Fees/IFee.type';
-import { RoomNightRateDTO } from './RoomNightRate.type';
+import { EBookingPaymentMethod } from "types/Booking/IBookingPayment.type";
+import { SimpleItemisedFee } from "types/Fees/IFee.type";
+import { RoomNightRateDTO } from "./RoomNightRateDTO";
 export type ReservationsDTO = {
     roomstayId: string;
     reservations: ReservationDTO[];
     itineraryNumber: string;
     hotelFrontendId?: string;
     warnings?: string[];
-    total?: ReservationDTO['total'];
-    payment?: IPaymentCheckoutDetails;
+    total?: string;
+    payment?: {
+        planpay?: {
+            id: string;
+            checkoutWorkflow: {
+                type: string;
+                id: string;
+                scriptUrl: string;
+            };
+        };
+        external?: {
+            id: string;
+            redirectUrl: string;
+        };
+        adyen?: {
+            roomstayId: string;
+            sessionData: string;
+            sessionId: string;
+            clientKey: string;
+            isLive: boolean;
+            currency: string;
+            amount: string;
+            countryCode: string;
+        };
+    };
     itemisedFees?: SimpleItemisedFee[];
     feesSummary?: SimpleItemisedFee[];
 };
@@ -30,8 +53,6 @@ export type ReservationAddonDTO = {
     adultPrice?: number;
     childPrice?: number;
     nights?: number;
-    discount?: number;
-    total?: number;
 };
 export type ReservationDTO = {
     nights: {
@@ -46,8 +67,6 @@ export type ReservationDTO = {
             line1: string;
             city: string;
             postalCode: string;
-            state?: string;
-            country?: string;
         };
         firstName: string;
         lastName: string;
@@ -80,6 +99,4 @@ export type ReservationDTO = {
         afterTax: number;
         beforeFees?: number;
     };
-    fees?: number;
 };
-//# sourceMappingURL=Reservations.type.d.ts.map

package/dist/types/{types/Api/RoomNightRate.type.d.ts → Api/RoomNightRateDTO.d.ts}

@@ -5,4 +5,3 @@ export type RoomNightRateDTO = {
     total: string;
     discount: string;
 };
-//# sourceMappingURL=RoomNightRate.type.d.ts.map

package/dist/types/{types/Booking/IBookingCreateErrorResponse.type.d.ts → Booking/IBookingCreateErrorResponse.d.ts}

@@ -1,4 +1,3 @@
-import { IPaymentCheckoutDetails } from './IBookingPayment.type';
 /**
  * This is the response body that comes down if a booking fails anywhere in the booking flow.
  *
@@ -7,8 +6,6 @@ import { IPaymentCheckoutDetails } from './IBookingPayment.type';
 export type IBookingCreateErrorResponse = {
     canRetryPayment: boolean;
     isPaymentTaken: boolean;
-    paymentRequired?: IPaymentCheckoutDetails;
     publicMessage: string;
     roomstayId: string;
 };
-//# sourceMappingURL=IBookingCreateErrorResponse.type.d.ts.map

package/dist/types/Booking/IBookingExtraFields.type.d.ts

@@ -1,7 +1,8 @@
 export declare enum EBookingCustomFieldFormat {
     Number = "number",
     Text = "text",
-    Date = "date"
+    Date = "date",
+    CarReg = "carreg"
 }
 export type IBookingCustomFields = {
     externalId: number;

package/dist/types/Booking/IBookingStatus.type.d.ts

@@ -0,0 +1,5 @@
+export declare enum IBookingStatus {
+    Pending = "Pending",
+    Committed = "Committed",
+    Cancelled = "Cancelled"
+}

package/dist/types/Booking/IPrice.type.d.ts

@@ -0,0 +1,7 @@
+export type IPrice = {
+    cost: number;
+    discount: number;
+    tax: number;
+    fee: number;
+    total: number;
+};

package/dist/types/Booking/PlaceBooking.types.d.ts

@@ -36,6 +36,7 @@ export type IPlaceBookingRoomsDTO = {
     adults: number;
     children: number;
     infants?: number;
+    pets?: number;
     checkInDate: Date;
     checkOutDate: Date;
     quoteId?: number;

package/dist/types/Company/ECompanyProvider.enum.d.ts

@@ -4,5 +4,6 @@ export declare enum ECompanyProvider {
     RMS = "RMS",
     Siteminder = "Siteminder",
     Roomstay = "Roomstay",
-    OHIP = "OHIP"
+    OHIP = "OHIP",
+    Newbook = "Newbook"
 }

package/dist/types/Company/IAdminCompany.type.d.ts

@@ -28,9 +28,15 @@ export interface IAdminCompany {
             apiUrl: string;
             pencilGuestId?: number;
         };
+        newbook?: {
+            apiKey: string;
+            instanceName: string;
+            region: string;
+        };
     }[];
     enableLighthouseAvailability: boolean;
     enableDerbysoftFeed: boolean;
+    isLoyaltyEnabled: boolean;
 }
 export type IAdminGetCompaniesResponse = IAdminCompany[];
 /** What the API expects */

package/dist/types/GiftCards/GiftCard.types.d.ts

@@ -315,6 +315,15 @@ export type IAdminGiftCardLogDTO = {
         new: string;
     }> | null;
 };
+/**
+ * Email branding configuration for gift card emails.
+ */
+export type IGiftCardEmailBranding = {
+    logoUrl: string;
+    primaryColor: string;
+    backgroundColor: string;
+    cardImageUrl: string;
+};
 /**
  * Schema for getting company gift card config (path parameters).
  */

package/dist/types/Hotel/IHotel.enum.d.ts

@@ -0,0 +1,32 @@
+export declare enum EPaymentCardType {
+    Visa = "VI",
+    Mastercard = "MC",
+    JCB = "JC",
+    AmericanExpress = "AX",
+    DinersClub = "DN",
+    UnionPay = "UP"
+}
+export declare enum HotelDataSource {
+    Synxis = "Synxis",
+    Roomstay = "Roomstay"
+}
+export declare enum PlanPayEnvStage {
+    Sandbox = "sbx",
+    Staging = "stag",
+    Production = "prod"
+}
+export declare enum DatepickerType {
+    Month = "Month",
+    Week = "Week"
+}
+export declare enum EHotelAvailabilityType {
+    PerRoomType = "PerRoom",
+    PerUnit = "PerUnit",
+    /** @deprecated In place while we move RMS Clients from Channel availability to Rest */
+    PerRoomOld = "PerRoomOld"
+}
+export declare enum EHotelMinPriceStrategy {
+    SingleDayAvailability = "SingleDayAvailability",
+    TwoDayMaxAvailability = "TwoDayMaxAvailability",
+    IncludeAllAvailability = "AllAvailability"
+}

package/dist/types/Hotel/IHotel.type.d.ts

@@ -0,0 +1,275 @@
+import { EBookingPaymentMethod, EHotelCardProcessor } from "../Booking/IBookingPayment.type";
+import { MediaType } from "../Media/IMedia.type";
+import { HotelRoomType } from "../Room/HotelRoom.type";
+import { HotelRoomGroupsType } from "../Room/IRoomGroup.type";
+import { EHotelPriceModel } from "./EHotelPriceModel.enum";
+import { EHotelStateFieldConfiguration } from "./EHotelStateFieldConfiguration.enum";
+import { EHotelWeekdayStartsOn } from "./EHotelWeekdayStartsOn.enum";
+import { EIntegration } from "./EIntegration.enum";
+import { DatepickerType, EPaymentCardType, HotelDataSource } from "./IHotel.enum";
+import { IHotelColorScheme } from "./IHotelColorScheme.type";
+import { EDistanceUnitType, IHotelOverrides } from "./IHotelOverrides.type";
+import { IHotelService } from "./IHotelService.type";
+import { ActiveCampaignConfigs, Big4Configs, GdayConfigs, PlanPayConfigs, PlanpayConfigs, TillPaymentsConfigs } from "./IntegrationConfigs.type";
+import { InternalMemberSignInInputs } from "./InternalMemberSignInModal.type";
+export interface IVGSVaultNames {
+    standard: string;
+    members: string;
+}
+export interface IChildConfiguration {
+    supportChildren: boolean;
+    supportInfants: boolean;
+    childRange: {
+        min: number;
+        max: number;
+    };
+    infantRange: {
+        min: number;
+        max: number;
+    };
+}
+export type AddressType = {
+    line1: string;
+    line2?: string;
+    line3?: string;
+    city: string;
+    postalCode: string;
+    state: string;
+    country: string;
+};
+export type DealDisplayStrategyType = {
+    includePromotionalRates?: boolean;
+    includeMemberDeals?: boolean;
+};
+export type FrontendPerkType = {
+    name: string;
+    icon?: string;
+    image?: MediaType["url"];
+};
+export type HotelPerkType = {
+    name: string;
+    icon?: any;
+    id?: string;
+    companyId?: number;
+    hotelId?: string;
+    mediaId?: string;
+    media?: MediaType;
+    order?: number;
+};
+export type AdminHotelPerkConfigurationType = {
+    title?: string;
+    perks?: HotelPerkType[];
+    companyIcons?: MediaType[];
+};
+export interface IHotel {
+    /** FE/Admin Begin*/
+    id: string;
+    name: string;
+    chainId: number;
+    chainName: string | null;
+    phone: string;
+    latitude: string;
+    longitude: string;
+    utcOffset: string;
+    timeZone: string;
+    languageCode: string;
+    currencyCode: string;
+    checkInTime: string;
+    checkOutTime: string;
+    description: string;
+    locationDescription: string;
+    vgsVaultName?: string;
+    vgsMembers?: string;
+    vgsStandard?: string;
+    email: string;
+    shortName: string;
+    perkTitle?: string;
+    countryPrefix?: string;
+    policies: string;
+    hotelUrl: string;
+    checkoutUrl?: string;
+    paymentCardTypes: EPaymentCardType[];
+    distanceUnitType: EDistanceUnitType;
+    businessServices: IHotelService[];
+    hotelServices: IHotelService[];
+    cardProcessor: EHotelCardProcessor;
+    dealDisplayStrategy?: DealDisplayStrategyType;
+    stateFieldConfiguration: EHotelStateFieldConfiguration;
+    weekdayStartsOn: EHotelWeekdayStartsOn;
+    planpay?: Omit<PlanPayConfigs, "password">;
+    requireDeposit: boolean;
+    enableCreditCardSurcharge: boolean;
+    preventSameDayBookingsForDirtyRooms: boolean;
+    preventCancellation: boolean;
+    showMealPill: boolean;
+    showAddonLoader: boolean;
+    captureChildAge: boolean;
+    maxAdults: number;
+    maxChildren: number;
+    maxInfants: number;
+    pendingBookingTimeout: number;
+}
+export interface IHotelFrontend extends IHotel {
+    /** FE Only Begin */
+    address: AddressType;
+    rooms: {
+        [roomName: string]: HotelRoomType;
+    };
+    roomGroups: HotelRoomGroupsType[];
+    dataSource: HotelDataSource;
+    paymentMethods: EBookingPaymentMethod[];
+    integrations: EIntegration[];
+    availableCountries?: {
+        name: string;
+        value: string;
+    }[];
+    childConfiguration?: IChildConfiguration;
+    memberOnlySignupInputs?: InternalMemberSignInInputs;
+    defaultDatepickerType?: DatepickerType;
+    googleReCaptcha?: {
+        loadForMembers: boolean;
+        siteKey: string;
+    };
+    overwrites?: {
+        [roomCode: string]: {
+            RoomDimensions?: string;
+            prePerkDisclaimer?: string;
+            perks?: FrontendPerkType[];
+        };
+    };
+    company?: {
+        url?: string;
+        logo?: string;
+    };
+    vgs?: {
+        vaultNames: IVGSVaultNames;
+    };
+    colors: IHotelColorScheme;
+    images: string[];
+    heroImage: string;
+    googleMapsImage?: string;
+    quoteImageDesktop?: string;
+    quoteImageMobile?: string;
+    memberOnlyImage?: string;
+    bookNowPayLaterUrl?: string;
+    bestRateUrl?: string;
+    providerHotelID?: string;
+    memberOnlyPromoCode?: string;
+    logo?: string;
+    memberOnlyRates?: string[];
+    crossSellHotelIds?: string[];
+    memberOnlyModalUsePrimaryColor: boolean;
+    memberOnlyRenderRateLast: boolean;
+    forwardFindReservationToSynxis: boolean;
+    onLoad?: string | (() => void);
+}
+export interface IHotelAdmin extends IHotel {
+    /** Admin Only Begin */
+    planpayConfigs: PlanpayConfigs;
+    big4Configs: Big4Configs;
+    gdayConfigs: GdayConfigs;
+    tillConfigs: TillPaymentsConfigs;
+    activeCampaignConfigs: ActiveCampaignConfigs;
+    integrations: {
+        planpay: PlanPayConfigs;
+        tillPayments: TillPaymentsConfigs;
+        big4: Big4Configs;
+    };
+    useMinimumStayOnArrival: boolean;
+    splitChildAndInfant: boolean;
+    supportChildren: boolean;
+    reCaptchaLoadForMembers: boolean;
+    roomstaySendsEmails: boolean;
+    roomstaySendsEmailsCancellation: boolean;
+    reservationContactEmail?: string;
+    reCaptchaSiteKey?: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    cityName?: string;
+    postalCode?: string;
+    state?: string;
+    country?: string;
+    availabilityType?: string;
+    calendarAvailabilityStrategy?: string;
+    cancellationEmailTemplate?: string;
+    confirmationEmailTemplate?: string;
+    ccBookingEmailsTo?: string;
+    crossSellDescription?: string;
+    crossSellHotelId?: string;
+    currentNightLastBookingTime?: string;
+    deletedDate?: string;
+    focusedCalendarRateId?: string;
+    frontendId: string;
+    providerId: string;
+    urlName?: string;
+    crossSellImagePath?: string;
+    environment?: string;
+    revinateToken?: string;
+    label?: string;
+    createdDate?: string;
+    updatedDate?: string;
+    supportedLanguages?: string[];
+    roomTypeCodes: string[];
+    rateMembersData: {
+        id: string;
+        rateCode: string;
+        hotelId: string;
+        companyId: number;
+    }[];
+    auxiliaryFilters: {
+        id: string;
+        name: string;
+        type: string;
+        includeAllAbove: boolean;
+        requireInput: boolean;
+        filterOptions: {
+            label: string;
+            value: number;
+        }[];
+    }[];
+    hotelColorScheme?: IHotelColorScheme;
+    hotelOverride?: IHotelOverrides;
+    images?: MediaType[];
+    logo?: MediaType;
+    heroImage?: MediaType;
+    googleMapsImage?: MediaType;
+    quoteImageDesktop?: MediaType;
+    quoteImageMobile?: MediaType;
+    memberOnlyImage?: MediaType;
+    maxChildAge?: number;
+    maxInfantAge?: number;
+    minChildAge?: number;
+    minInfantAge?: number;
+    passTemporaryBookingComment?: boolean;
+    preferProviderBookingId?: boolean;
+    perkConfiguration?: AdminHotelPerkConfigurationType;
+    priceModel: EHotelPriceModel;
+    providerData?: IHotelProviderData;
+    startsWeekOnDay: EHotelWeekdayStartsOn;
+}
+export interface IHotelProviderData {
+    rooms: {
+        [roomCode: string]: {
+            code: string;
+            name: string;
+            shortDescription: string;
+            longDescription: string;
+            bedType: string;
+            images: string[];
+            quantity: number;
+            maxOccupancy: number;
+            bedQuantity: number;
+            standardNumBeds: number;
+            maxRollaways: number;
+            amenities: {
+                type: string;
+                description: string;
+            }[];
+            features: {
+                type: string;
+                description: string;
+            }[];
+        };
+    };
+}

package/dist/types/Hotel/IntegrationConfigs.type.d.ts

@@ -0,0 +1,76 @@
+export interface PlanpayConfigs {
+    deletedDate: string;
+    createdDate: string;
+    updatedDate: string;
+    companyId: number;
+    hotelId: string;
+    enabled: boolean;
+    username: string;
+    password: string;
+    endpoint: string;
+    minDaysShowPlanpay: number;
+    env: string;
+}
+export interface Big4Configs {
+    deletedDate: string;
+    createdDate: string;
+    updatedDate: string;
+    companyId: number;
+    hotelId: string;
+    enabled: boolean;
+    big4ParkId: string;
+    freeDiscountId: number;
+    perksPlusDiscountId: number;
+    vipPerksDiscountId: number;
+}
+export interface PlanPayConfigs {
+    username: string;
+    password: string;
+    env: string;
+    minDaysShowPlanpay: number;
+    enabled?: boolean;
+}
+export interface TillPaymentsConfigs {
+    deletedDate: string;
+    createdDate: string;
+    updatedDate: string;
+    companyId: number;
+    hotelId: string;
+    enabled: boolean;
+    apiKey: string;
+    sharedSecred: string;
+    apiUsername: string;
+    apiPassword: string;
+    useTestingDatabase: boolean;
+    includeSignature: boolean;
+    publicIntegrationKey: string;
+}
+export interface Big4Configs {
+    parkId: string;
+    freeDiscountId: number;
+    perksPlusDiscountId: number;
+    vipPerksDiscountId: number;
+    enabled: boolean;
+}
+export interface ActiveCampaignConfigs {
+    deletedDate: string;
+    createdDate: string;
+    updatedDate: string;
+    companyId: number;
+    hotelId: string;
+    enabled: boolean;
+    apiUrl: string;
+    apiKey: string;
+    listId: number;
+    tagName: string;
+}
+export interface GdayConfigs {
+    deletedDate: string;
+    createdDate: string;
+    updatedDate: string;
+    parkId: string;
+    gdayDiscountId: number;
+    companyId: number;
+    hotelId: string;
+    enabled: boolean;
+}

package/dist/types/Hotel/InternalMemberSignInModal.type.d.ts

@@ -0,0 +1,13 @@
+export type InputGroupDimensions = "1" | "2/2" | "3/1" | "1/3" | "1/2/2" | "1/1/1";
+export interface InternalMemberSignInInputs {
+    Lines: {
+        Dimension: InputGroupDimensions;
+        Inputs: {
+            name: string;
+            type: "TextBox";
+            placeholder?: string;
+            isRequired?: boolean;
+            validate?: (value: string) => string | boolean;
+        }[];
+    }[];
+}

package/dist/types/Hotel/InternalMemberSignInModal.types.d.ts

@@ -0,0 +1,13 @@
+export type InputGroupDimensions = "1" | "2/2" | "3/1" | "1/3" | "1/2/2" | "1/1/1";
+export interface InternalMemberSignInInputs {
+    Lines: {
+        Dimension: InputGroupDimensions;
+        Inputs: {
+            name: string;
+            type: "TextBox";
+            placeholder?: string;
+            isRequired?: boolean;
+            validate?: (value: string) => string | boolean;
+        }[];
+    }[];
+}

package/dist/types/Maintenance/IMaintenanceStatus.type.d.ts

@@ -1,5 +1,4 @@
 export type IMaintenanceStatus = {
-    uuid: string;
     /**
      * Which service is currently experiencing issues.
      */
@@ -10,6 +9,10 @@ export type IMaintenanceStatus = {
      * @example 2023-10-01T00:00:00Z
      */
     startDate: string;
+    /**
+     * UUID generated on create. Is not used as a primary key, or an index.
+     */
+    uuid: string;
     endDate: string;
     /**
      * Whether the status is currently in effect or not