@roomstay/core 0.1.74-4 → 0.1.74

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

@@ -0,0 +1,53 @@
+import { EDistanceUnitType, EHotelPriceModel, EHotelWeekdayStartsOn, IHotelColorScheme, IHotelOverrides, IHotelService } from "../../index.js";
+export type IHotelReplica = {
+    hotelId: string;
+    addressLine1: string;
+    addressLine2: string;
+    addressLine3: string;
+    businessServices: IHotelService[];
+    cancellationEmailTemplate: string;
+    ccBookingEmailsTo: string;
+    chainId: number;
+    chainName: string;
+    checkInTime: string;
+    checkOutTime: string;
+    checkOutUrl: string;
+    cityName: string;
+    confirmationEmailTemplate: string;
+    country: string;
+    crossSellDescription: string;
+    crossSellHotelId: string;
+    currencyCode: string;
+    deletedDate: string;
+    description: string;
+    distanceUnitType: EDistanceUnitType;
+    email: string;
+    frontendId: string;
+    heroImage: any;
+    hotelColorScheme: IHotelColorScheme;
+    hotelOverrides?: IHotelOverrides;
+    hotelService: IHotelService[];
+    hotelUrl: string;
+    images: any[];
+    label: string;
+    languageCode: string;
+    latitude: string;
+    longitude: string;
+    locationDescription: string;
+    name: string;
+    paymentCardTypes: string[];
+    phone: string;
+    policies: string;
+    postCode: string;
+    priceModel: EHotelPriceModel;
+    providerData: any;
+    providerId: string;
+    reservationContactEmail: string;
+    roomTypeCodes: string[];
+    roomstaySendsEmails: boolean;
+    state: string;
+    supportedLanguages: string[];
+    urlName: string;
+    utcOffset: string;
+    weekdayStartsOn: EHotelWeekdayStartsOn;
+};

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

@@ -0,0 +1,6 @@
+export type IHotelService = {
+    name: string;
+    detail: string;
+    onsite: boolean;
+    included: boolean;
+};

package/dist/types/types/Image/IRoomstayImage.type.d.ts

@@ -0,0 +1,8 @@
+export declare enum ERoomstayImageSize {
+    Icon = 128,
+    Tiny = 256,
+    Small = 512,
+    Medium = 768,
+    Large = 1024,
+    ExtraLarge = 1600
+}

package/dist/types/types/Member/IRoomstayCognitoMember.type.d.ts

@@ -0,0 +1,4 @@
+export type IRoomstayCognitoMember = {
+    ["custom:forename"]?: string;
+    ["custom:surname"]?: string;
+};

package/dist/types/types/Member/IRoomstayMember.type.d.ts

@@ -0,0 +1,17 @@
+import { IRoomstayCognitoMember, IRoomstayMemberBooking, IRoomstayMemberCards } from "../../index.js";
+export interface IRoomstayMember extends IRoomstayCognitoMember {
+    username: string;
+    email: string;
+    forename?: string;
+    surname?: string;
+    phoneNumber?: string;
+    address?: {
+        address?: string;
+        city?: string;
+        zip?: string;
+        country?: string;
+    };
+    defaultCard: string;
+    bookings: IRoomstayMemberBooking[];
+    cards: IRoomstayMemberCards[];
+}

package/dist/types/types/Member/IRoomstayMemberBooking.type.d.ts

@@ -0,0 +1,28 @@
+import { IHotelColorScheme, IRoomstayMemberBookingItem } from "../../index.js";
+/**
+ * DynamoDB object reference for a Member Booking
+ */
+export interface IRoomstayMemberBooking {
+    username: string;
+    itineraryId: string;
+    hotelId: string;
+    hotel: {
+        name: string;
+        address: {
+            line1: string;
+            line2: string;
+            line3: string;
+            city: string;
+            postalCode: string;
+            state: string;
+            country: string;
+        };
+        phone: string;
+        checkInTime: string;
+        checkOutTime: string;
+        colors: IHotelColorScheme;
+    };
+    itinerary: {
+        [id: string]: IRoomstayMemberBookingItem;
+    };
+}

package/dist/types/types/Member/IRoomstayMemberBookingAddress.type.d.ts

@@ -0,0 +1,9 @@
+export type IRoomstayMemberBookingAddress = {
+    line1: string;
+    line2: string;
+    line3?: string;
+    city: string;
+    postalCode: string;
+    state: string;
+    country: string;
+};

package/dist/types/types/Member/IRoomstayMemberBookingItem.type.d.ts

@@ -0,0 +1,25 @@
+import { IBookingStatus, IPrice, IRoomstayMemberBookingProfile } from "../../index.js";
+export type IRoomstayMemberBookingItem = {
+    id: string;
+    roomCode: string;
+    roomName: string;
+    images: string[];
+    rateCode: string;
+    rateName: string;
+    adults: number;
+    children?: number;
+    profile: IRoomstayMemberBookingProfile;
+    comments: string[];
+    status: IBookingStatus;
+    isCancellable: boolean;
+    checkInDate: string;
+    checkOutDate: string;
+    nights: {
+        [date: string]: IPrice;
+    };
+    cancellationPolicy: string;
+    guaranteePolicy: string;
+    promoCode?: string;
+    cancellationPolicyLongDescription?: string;
+    guaranteePolicyLongDescription?: string;
+};

package/dist/types/types/Member/IRoomstayMemberBookingProfile.type.d.ts

@@ -0,0 +1,11 @@
+import { IRoomstayMemberBookingAddress } from "../../index.js";
+export type IRoomstayMemberBookingProfile = {
+    title: string;
+    firstName: string;
+    middleName?: string;
+    lastName: string;
+    phone?: string;
+    email?: string;
+    marketingOptIn?: boolean;
+    address: IRoomstayMemberBookingAddress;
+};

package/dist/types/types/Member/IRoomstayMemberCards.type.d.ts

@@ -0,0 +1,12 @@
+/**
+ * These details will always be VGS tokenized strings, for use in the front end
+ */
+export interface IRoomstayMemberCards {
+    username: string;
+    cardId: string;
+    cardNumber: string;
+    expiry: string;
+    securityCode: string;
+    name: string;
+    type: string;
+}

package/dist/types/types/Member/ISession.type.d.ts

@@ -0,0 +1,4 @@
+export interface ISession {
+    id: string;
+    hits: number;
+}

package/dist/types/types/Policies/EGuaranteePolicy.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum EGuarantyPolicyPrepaymentType {
+    FixedAmount = "fixed",
+    Percentage = "percentage",
+    Nights = "nights"
+}

package/dist/types/types/RMS/ERMSDiscountType.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum ERMSDiscountType {
+    Percentage = "Percentage",
+    Amount = "Amount",
+    Bogo = "BOGO"
+}

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

@@ -0,0 +1,28 @@
+import { ERMSDiscountType } from './ERMSDiscountType.enum';
+export type IRMSPropertyDiscount = {
+    name: string;
+    hotelId: string;
+    rmsDiscountId: number;
+    description: string;
+    discountType: ERMSDiscountType;
+    amount?: {
+        amount: number;
+    };
+    percentage?: {
+        percentage: number;
+        noGreaterThan: number;
+        includePackage: boolean;
+        includeAdditionals: boolean;
+        appliesToTotalRate: boolean;
+    };
+    bogo?: {
+        buyXNights: number;
+        getXNights: number;
+        getXNightsCycles: number;
+        includeAdditionals: boolean;
+    };
+    availableToIbe: boolean;
+    minimumNightStay: number;
+    maximumNightStay: number;
+    availableToMembers: boolean;
+};

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

@@ -0,0 +1,19 @@
+export type IRMSRequirement = {
+    chargeDailyIncludeToDate: boolean;
+    chargeRequiredDaily: boolean;
+    code: string;
+    groupingId: number;
+    note: string;
+    sundryId: number;
+    unitPrice: number;
+    useSundryAmount: boolean;
+    feeType: string;
+    adultAmount: number;
+    childAmount: number;
+    infantAmount: number;
+    amount: number;
+    quantity: number;
+    requiredDaily: boolean;
+    id: number;
+    name: string;
+};

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

@@ -0,0 +1,11 @@
+export type IRoomGroup = {
+    companyId: number;
+    hotelId: string;
+    id: string;
+    groupName: string;
+    /** this will be a list of room codes */
+    rooms: string[];
+    auxiliaryFilters: {
+        [name: string]: boolean;
+    };
+};

package/dist/types/types/index.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Booking Details
+ */
+export * from "./Booking/IPrice.type";
+export * from "./Booking/IBookingStatus.type";
+export * from "./Booking/IBookingPayment.type";
+export * from './Booking/IBookingQuote.type';
+export * from './Booking/IBookingCreateErrorResponse';
+/**
+ * Company
+ */
+export * from './Company/IAdminCompany.type';
+export * from './Company/ECompanyProvider.enum';
+/**
+ * Hotel
+ */
+export * from "./Hotel/IHotelColorScheme.type";
+export * from "./Hotel/IHotelReplica.type";
+export * from "./Hotel/IHotelOverrides.type";
+export * from "./Hotel/IHotelService.type";
+export * from "./Hotel/EHotelPriceModel.enum";
+export * from "./Hotel/EHotelWeekdayStartsOn.enum";
+export * from './Hotel/IAuxiliaryFilter.type';
+/**
+ * Room
+ */
+export * from './Room/IRoomGroup.type';
+/**
+ * RMS
+ */
+export * from './RMS/IRMSPropertyDiscount.type';
+export * from './RMS/ERMSDiscountType.enum';
+export * from './RMS/IRMSRequirement.type';
+/**
+ * Image
+ */
+export * from './Image/IRoomstayImage.type';
+/**
+ * Member Details
+ */
+export * from "./Member/IRoomstayCognitoMember.type";
+export * from "./Member/IRoomstayMember.type";
+export * from "./Member/IRoomstayMemberBooking.type";
+export * from "./Member/IRoomstayMemberBookingItem.type";
+export * from "./Member/IRoomstayMemberBookingProfile.type";
+export * from "./Member/IRoomstayMemberBookingAddress.type";
+export * from "./Member/IRoomstayMemberCards.type";
+export * from "./Member/ISession.type";
+/**
+ * Policies
+ */
+export * from './Policies/EGuaranteePolicy.enum';
+/**
+ * Roomstay Events
+ */
+export * from "./Events/IRoomstayEvent.type";

package/dist/types/utils/bookingTotal.d.ts

@@ -0,0 +1,7 @@
+import { IRoomstayMemberBooking } from "../index.js";
+/**
+ * Calculates the total AFTER tax of the booking.
+ *
+ * @param reservation IRoomstayMemberBooking
+ */
+export declare const calculateTotalForMemberBooking: (reservation: IRoomstayMemberBooking) => number;

package/dist/types/utils/calendarHelper.d.ts

@@ -0,0 +1,16 @@
+import dayjs from "dayjs";
+import { WeekdayStartsOn } from "@models/Client/Hotel/WeekdayStartsOn.types";
+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/types/utils/color.d.ts

@@ -0,0 +1,20 @@
+import { IHotelColorScheme } from "../index.js";
+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)"
+}
+/** Returns the style tag content for overriding default colors. Insert this in an existing style tag, you'll need to specify your own target */
+export declare const getAccentOverrideStyleContent: (color: IHotelColorScheme) => string;

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

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

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

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

package/dist/types/utils/roomstayImageResize.d.ts

@@ -0,0 +1,14 @@
+import { ERoomstayImageSize } from '../index.js';
+/**
+ * Converts an Image URL to a resized image URL.
+ *
+ * Right now we can only manipulate Roomstay hosted images in S3, so only where the source
+ * image URL contains cdn.app.roomstay.io can we add the resize parameters.
+ *
+ * This function will simply pass through any URL not matching the criteria
+ *
+ * @param url string
+ * @param size ImageSize
+ * @returns
+ */
+export declare const resizeRoomstayImageUrl: (url: string, size: ERoomstayImageSize) => string;

package/dist/types/utils/uppercaseString.d.ts

@@ -0,0 +1 @@
+export declare function uppercaseString(toUppercase: string): string;

package/dist/utils/roundMoney.d.ts

@@ -1,11 +1,3 @@
-import Decimal from "decimal.js";
-export declare const RoundingType: {
-    [key: string]: Decimal.Rounding;
-};
-interface RoundMoneyOptions {
-    precision?: number;
-    rounding?: Decimal.Rounding;
-}
 /**
  * Rounds a monetary amount to two decimal places.
  *
@@ -13,8 +5,6 @@ interface RoundMoneyOptions {
  * with some systems, such as RMS.
  *
  * @param amount a string or number to be rounded
- * @param options an object containing precision and rounding options
  * @returns the rounded amount as a number
  */
-export declare const roundMoney: (amount: string | number, options?: RoundMoneyOptions) => number;
-export {};
+export declare const roundMoney: (amount: string | number) => number;