@roomstay/core 0.1.76-2 → 0.1.76-4

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/PromoCode/PromoCodeStayDateRangeType.enum.d.ts

@@ -0,0 +1,11 @@
+export declare enum EPromoCodeStayDateRangeType {
+    Allowed = "Allowed",
+    Blocked = "Blocked"
+}
+export declare enum EPromoCodeStayDateRangeRepeatType {
+    None = "None",
+    Weekly = "Weekly",
+    MonthlyDayOfWeek = "MonthlyDayOfWeek",
+    MonthlyDate = "MonthlyDate",
+    Yearly = "Yearly"
+}

package/dist/types/RMS/RMSBookingSource.type.d.ts

@@ -0,0 +1,7 @@
+export type RMSBookingSourceType = {
+    id: number;
+    companyId: number;
+    hotelId: string;
+    name: string;
+    code: string;
+};

package/dist/types/Room/HotelRoom.type.d.ts

@@ -0,0 +1,24 @@
+export type HotelRoomAmenitiesType = {
+    type: string;
+    description: string;
+};
+export declare class HotelRoomType {
+    code: string;
+    name: string;
+    shortDescription: string;
+    longDescription: string;
+    images: string[];
+    quantity: number;
+    maxOccupancy: number;
+    bedQuantity: number;
+    showBedType?: boolean;
+    standardNumBeds: number;
+    maxRollaways: number;
+    bedType: string;
+    amenities: HotelRoomAmenitiesType[];
+    features: HotelRoomAmenitiesType[];
+    bedTypeOverride?: string;
+    roomGroupId?: string;
+    roomSize?: number;
+    prePerkDisclaimer?: string;
+}

package/dist/types/Room/SynxisRoom.type.d.ts

@@ -0,0 +1,35 @@
+export declare class SynxisRoom {
+    /** Room Type Code for this room in SynXis CR. */
+    code: string;
+    /** Name of the room type */
+    name: string;
+    shortDescription: string;
+    longDescription: string;
+    images: string[];
+    amenities: {
+        type: string;
+        description: string;
+    }[];
+    features: {
+        type: string;
+        description: string;
+    }[];
+    /** The number of guest rooms at the hotel for the guest room type. */
+    quantity: number;
+    /** The maximum guest occupancy for the SynXis CR room type. */
+    maxOccupancy: number;
+    /** Sum of the total number of Beds for the room type. */
+    standardNumBeds?: number;
+    /** Number of rollaways allowed in this room type */
+    maxRollaways?: number;
+    /** The type of beds in the room. */
+    bedType?: string;
+    /** Stored quantity for the default or primary bed type. */
+    bedQuantity?: number;
+    /** The view of the room. */
+    roomViewType?: string;
+    bedTypeOverride?: string;
+    roomGroupId?: string;
+    showBedType?: boolean;
+    roomSize?: number;
+}

package/dist/types/index.d.ts

@@ -9,13 +9,13 @@ export * from './Booking/ConfirmBooking.types';
 export * from './Booking/EBooking.types';
 export * from './Booking/GetBooking.types';
 export * from './Booking/IBookingCreateErrorResponse.type';
+export * from './Booking/IBookingExtraFields.type';
 export * from './Booking/IBookingPayment.type';
 export * from './Booking/IBookingQuote.type';
 export * from './Booking/ICommonQueryParameters.type';
 export * from './Booking/Itinerary.types';
 export * from './Booking/PencilReservation.types';
 export * from './Booking/PlaceBooking.types';
-export * from './Booking/IBookingExtraFields.type';
 /**
  * Company
  */
@@ -25,6 +25,7 @@ export * from './Company/IAdminCompanyUser.type';
 /**
  * Hotel
  */
+export * from './Hotel/EHotelAddressRequirement.enum';
 export * from './Hotel/EHotelPriceModel.enum';
 export * from './Hotel/EHotelStateFieldConfiguration.enum';
 export * from './Hotel/EHotelWeekdayStartsOn.enum';
@@ -41,12 +42,13 @@ export * from './Room/IRoomGroup.type';
 /**
  * RMS
  */
+export * from './RMS/ERMSAuthSyncHistoryStatus.type';
 export * from './RMS/ERMSDiscountType.enum';
+export * from './RMS/ERMSSyncStrategy.enum';
 export * from './RMS/IRMSPropertyDiscount.type';
 export * from './RMS/IRMSRequirement.type';
-export * from './RMS/ERMSSyncStrategy.enum';
-export * from './RMS/ERMSAuthSyncHistoryStatus.type';
 export * from './RMS/IRMSSyncResponse.type';
+export * from './RMS/RMSBookingSource.type';
 /**
  * OHIP
  */
@@ -83,6 +85,7 @@ export * from './Policies/EGuaranteePolicy.enum';
  * PromoCode
  */
 export * from './PromoCode/EPromoCodeDiscountType.enum';
+export * from './PromoCode/PromoCodeStayDateRangeType.enum';
 /**
  * Roomstay Events
  */
@@ -118,8 +121,8 @@ export * from './Analytics/IBigQueryResults.type';
 /**
  * Analytics Events
  */
-export * from './AnalyticsEvents/IAnalyticsSession.type';
 export * from './AnalyticsEvents/IAnalyticsEvent.type';
+export * from './AnalyticsEvents/IAnalyticsSession.type';
 export * from './AnalyticsEvents/IRoomstayEventData.type';
 export * from './AnalyticsEvents/MetaCapiTransformer';
 /**

package/dist/utils/CalendarHelper.d.ts

@@ -0,0 +1,16 @@
+import dayjs from 'dayjs';
+import { WeekdayStartsOn } from '../index.web';
+export declare const getLetterDaysOfWeek: (startsWeekOnDay: string) => string[];
+export default class CalendarHelper {
+    /**
+     * Returns an array always divisible by 7,
+     *
+     * Essentially no matter what what month is given, this function will always return the same number of days;
+     * with each MOD 7 index representing the correct date.
+     */
+    static getWeekPaddedMonthArrayForDate: (startWeekOnDay: WeekdayStartsOn, date: dayjs.Dayjs) => string[];
+    static getMonthArray: (date: dayjs.Dayjs) => dayjs.Dayjs[];
+    static getWeekFrom: (date: dayjs.Dayjs) => dayjs.Dayjs[];
+    static getWeekTo: (date: dayjs.Dayjs) => dayjs.Dayjs[];
+    static getDaysBetween: (startDate: dayjs.Dayjs, endDate: dayjs.Dayjs) => dayjs.Dayjs[];
+}

package/dist/utils/color.d.ts

@@ -0,0 +1,17 @@
+export declare enum Color {
+    Accent = "var(--rs-color-accent-1)",
+    Accent2 = "var(--rs-color-accent-2)",
+    Accent3 = "var(--rs-color-accent-3)",
+    Success = "var(--rs-color-success)",
+    SuccessTint = "var(--rs-color-success-tint)",
+    Danger = "var(--rs-color-danger)",
+    Warning = "var(--rs-color-warning)",
+    Alert = "var(--rs-color-alert)",
+    Graphite = "var(--rs-color-graphite)",
+    DarkGrey = "var(--rs-color-dark-grey)",
+    Grey = "var(--rs-color-grey)",
+    LightGrey = "var(--rs-color-light-grey)",
+    Snow = "var(--rs-color-snow)",
+    Navy = "var(--rs-color-navy)",
+    White = "var(--rs-color-white)"
+}

package/dist/utils/index.node.d.ts

@@ -0,0 +1,2 @@
+export * from "./uppercaseString";
+export * from "./bookingTotal";

package/dist/utils/index.web.d.ts

@@ -0,0 +1,4 @@
+export * from "./uppercaseString";
+export * from "./bookingTotal";
+export * from "./color";
+export * from "./CalendarHelper";