@roomstay/core 0.1.54 → 0.1.56-0

package/dist/types/Api/ReservationsDTO.d.ts

@@ -0,0 +1,102 @@
+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?: 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[];
+};
+export type ReservationAddonDTO = {
+    code: string;
+    inclusive: false;
+    pricingType: string;
+    quantity: number;
+    adultQuantity: number;
+    childQuantity?: number;
+    description: string;
+    name: string;
+    category: string;
+    image: string;
+    price: number;
+    fees?: number;
+    itemisedFees?: SimpleItemisedFee[];
+    displayPrice: number;
+    adultPrice?: number;
+    childPrice?: number;
+    nights?: number;
+};
+export type ReservationDTO = {
+    nights: {
+        [date: string]: RoomNightRateDTO;
+    };
+    guestCounts: {
+        adults: number;
+        children: number;
+    };
+    guest: {
+        address: {
+            line1: string;
+            city: string;
+            postalCode: string;
+        };
+        firstName: string;
+        lastName: string;
+        phone: string;
+        email: string;
+    };
+    paymentCard: {
+        type?: string;
+        last4: string;
+        expiry: string;
+        name: string;
+    };
+    paymentMethod?: EBookingPaymentMethod;
+    comments?: string[];
+    addons?: ReservationAddonDTO[];
+    itemisedFees?: SimpleItemisedFee[];
+    reservationNumber: string;
+    cancelPolicy: string;
+    cancellationPolicyLongDescription?: string;
+    guaranteePolicy: string;
+    guaranteePolicyLongDescription?: string;
+    roomType: string;
+    roomCode: string;
+    rate: string;
+    images: [string];
+    status: string;
+    isCancelable: boolean;
+    total: {
+        beforeTax: number;
+        afterTax: number;
+        beforeFees?: number;
+    };
+};

package/dist/types/Api/RoomNightRateDTO.d.ts

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

package/dist/types/Availability/Availability.types.d.ts

@@ -0,0 +1,99 @@
+import { EGuaranteePolicyDepositMode } from '../Policies/EGuaranteePolicy.enum';
+import { IItemisedBookingFeeResponse } from '../Booking/Itinerary.types';
+import { Warning } from "../General/Warning.type";
+export type IAvailability = {
+    roomTypes: {
+        [roomTypeCode: string]: IRoomType;
+    };
+    ratePlans: {
+        [ratePlanCode: string]: IRatePlan;
+    };
+    roomNights: {
+        [date: string]: {
+            [roomTypeCode: string]: IRoomNight;
+        };
+    };
+    guaranteePolicies: {
+        [policyCode: string]: IAvailabilityGuaranteePolicyDetails;
+    };
+    cancelPolicies: {
+        [policyCode: string]: string;
+    };
+    warnings: Warning<string>[];
+    alternativeAvailability?: IAlternativeAvailability;
+};
+export type IAlternativeAvailability = {
+    checkInDate: string;
+    checkOutDate: string;
+    availability: IAvailability;
+};
+export type IAvailabilityGuaranteePolicyDetails = {
+    code: string;
+    name: string;
+    longDescription: string;
+    depositMode: EGuaranteePolicyDepositMode;
+    depositPercentage?: number;
+    hide: boolean;
+};
+export type IRoomType = {
+    name: string;
+    shortDescription: string;
+    longDescription: string;
+    imageUrls: string[];
+    occupancy: number;
+    roomGroupId?: string | null;
+    auxiliaryValues?: {
+        [auxiliaryFilterId: string]: string[];
+    };
+    order: number;
+};
+export type IRatePlan = {
+    name: string;
+    description: string;
+    longDescription?: string | null;
+    guaranteeCode: string;
+    cancelPolicyCode: string;
+    promoCode?: string | null;
+    promoCodeName?: string | null;
+    mealsIncluded: {
+        breakfast: boolean;
+        lunch: boolean;
+        dinner: boolean;
+        mealPlan: string | undefined;
+    };
+    rateOverrides: IRateOverride[];
+};
+export type IRoomNight = {
+    available: number;
+    lowestPrice: number;
+    rates: {
+        [ratePlanCode: string]: IRoomNightRatePlan;
+    };
+};
+export type IRoomNightRatePlan = {
+    cost: number;
+    discount: number;
+    tax: number;
+    fee: number;
+    total: number;
+    fees?: IItemisedBookingFeeResponse[];
+};
+export type IRateOverride = {
+    name: string;
+    shortDescription: string;
+    longDescription: string;
+    enabledPerDay: IRateLabelsByDay | null;
+    startDate: string;
+    endDate: string | null;
+    queryStartDate: string | null;
+    queryEndDate: string | null;
+};
+export type IRateLabelsByDay = {
+    Monday: boolean;
+    Tuesday: boolean;
+    Wednesday: boolean;
+    Thursday: boolean;
+    Friday: boolean;
+    Saturday: boolean;
+    Sunday: boolean;
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This is the response body that comes down if a booking fails anywhere in the booking flow.
+ *
+ * Object will contain a public message only, with partial reservation data to be able to attempt to "resume" the booking
+ */
+export type IBookingCreateErrorResponse = {
+    canRetryPayment: boolean;
+    isPaymentTaken: boolean;
+    publicMessage: string;
+    roomstayId: string;
+};

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

@@ -22,7 +22,7 @@ export declare enum EHotelCardProcessor {
     Mastercard = "Mastercard"
 }
 export declare enum EPlanpayBookingStatus {
-    Unknown = "unknown",
+    Unknown = "unknown",// incase plan.deposit.status is unavailable
     Unpaid = "unpaid",
     Accepted = "accepted",
     Cancelled = "cancelled",

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/Company/ECompanyProvider.enum.d.ts

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

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

@@ -8,7 +8,12 @@ export interface IAdminCompany {
     providerLogin: string;
     providerPassword: string;
     isGiftCardsEnabled: boolean;
+    /**
+     * @deprecated Use `isRoomstayEventsEnabled` or `isHotelEventsEnabled` instead.
+     */
     isEventsEnabled: boolean;
+    isRoomstayEventsEnabled: boolean;
+    isHotelEventsEnabled: boolean;
     isAnalyticsEnabled: boolean;
     preventMemberPortalWelcomeEmails: boolean;
     hotels: {

package/dist/types/Fees/IFee.type.d.ts

@@ -1,6 +1,11 @@
-import { EFeeType } from "./EFeeType.enum";
+import { EFeeType } from './EFeeType.enum';
 export interface IFee {
     name: string;
     amount: number;
     feeType: EFeeType;
 }
+export type SimpleItemisedFee = {
+    name: string;
+    description?: string;
+    amount: number;
+};

package/dist/types/General/Warning.type.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A standard warning object with a type, message and extra data
+ * @example
+ * const warn: Warning<{ field: string; issue: string }> = {
+ *   type: 'VALIDATION_WARNING',
+ *   data: { field: 'email', issue: 'invalid_format' },
+ *   message: 'Email address is not properly formatted.',
+ * };
+ */
+export type Warning<TData = unknown> = {
+    type: string;
+    data: TData;
+    message: string;
+};

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

@@ -3,5 +3,6 @@ export declare enum EIntegration {
     RmsTop10 = "Top10",
     Top10 = "NewTop10",
     Gday = "Gday",
-    Salesforce = "Salesforce"
+    Salesforce = "Salesforce",
+    RAC = "RAC"
 }

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;
+}