@roomstay/core 0.1.80 → 0.2.0-1

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

@@ -1,26 +0,0 @@
-export type IMaintenanceStatus = {
-    uuid: string;
-    /**
-     * Which service is currently experiencing issues.
-     */
-    service: IMaintenanceStatusService;
-    /**
-     * The start time of the maintenance window in ISO 8601 format
-     *
-     * @example 2023-10-01T00:00:00Z
-     */
-    startDate: string;
-    endDate: string;
-    /**
-     * Whether the status is currently in effect or not
-     */
-    isActive: boolean;
-    status: 'error' | 'maintenance';
-    title: string;
-    message: string;
-};
-export declare enum IMaintenanceStatusService {
-    Frontend = "frontend",
-    Hotel = "hotel",
-    Events = "events"
-}

package/dist/types/Media/IMedia.type.d.ts

@@ -1,10 +0,0 @@
-export interface MediaType {
-    id: string;
-    name: string;
-    size?: number;
-    url: string;
-    order?: number;
-    createdDate?: string;
-    updatedDate?: string;
-    mediaTarget?: string;
-}

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

@@ -1,7 +0,0 @@
-/**
- * General membership information passing by the API.
- */
-export interface IMember {
-    memberId: string;
-    promoCode: string;
-}

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

@@ -1,10 +0,0 @@
-/**
- * Extendable list of parameters used to verify a membership.
- */
-export interface IMemberVerification {
-    memberNumber?: string;
-    lastName?: string;
-    firstName?: string;
-    email?: string;
-    password?: string;
-}

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

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

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

@@ -1,18 +0,0 @@
-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;
-        state?: string;
-        country?: string;
-    };
-    defaultCard: string;
-    bookings: IRoomstayMemberBooking[];
-    cards: IRoomstayMemberCards[];
-}

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

@@ -1,28 +0,0 @@
-import { IRoomstayMemberBookingItem, IHotelColorScheme } 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/Member/IRoomstayMemberBookingAddress.type.d.ts

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

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

@@ -1,25 +0,0 @@
-import { EBookingStatus, 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: EBookingStatus;
-    isCancellable: boolean;
-    checkInDate: string;
-    checkOutDate: string;
-    nights: {
-        [date: string]: IPrice;
-    };
-    cancellationPolicy: string;
-    guaranteePolicy: string;
-    promoCode?: string;
-    cancellationPolicyLongDescription?: string;
-    guaranteePolicyLongDescription?: string;
-};

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

@@ -1,11 +0,0 @@
-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/Member/IRoomstayMemberCards.type.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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/Member/IRoomstayMemberJWTData.type.d.ts

@@ -1,3 +0,0 @@
-export type IRoomstayMemberJWTData = {
-    'cognito:username': string;
-};

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

@@ -1,16 +0,0 @@
-export interface IRoomstayMemberLoyalty {
-    username: string;
-    hotelId: string;
-    spendingBalance: number;
-    currentTier: number | null;
-    promoCodeId: string | null;
-    promoCode: string | null;
-    redeemedAt: string | null;
-    lastBookingId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface ILoyaltyTier {
-    threshold: number;
-    discountPercent: number;
-}

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

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

package/dist/types/Newbook/ENewbookRegion.enum.d.ts

@@ -1,7 +0,0 @@
-export declare enum ENewbookRegion {
-    Australia = "au",
-    AsiaPacific = "ap",
-    Europe = "eu",
-    UnitedStates = "us",
-    Staging = "staging"
-}

package/dist/types/Newbook/ENewbookSyncStrategy.enum.d.ts

@@ -1,5 +0,0 @@
-export declare enum ENewbookSyncStrategy {
-    Rates = "rates",
-    Rooms = "rooms",
-    Availability = "availability"
-}

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

@@ -1,2 +0,0 @@
-export * from './ENewbookRegion.enum';
-export * from './ENewbookSyncStrategy.enum';

package/dist/types/OHIP/IOHIPConfiguration.types.d.ts

@@ -1,12 +0,0 @@
-export type IOHIPConfiguration = {
-    clientId: string | null;
-    clientSecret: string | null;
-    enterpriseId: string | null;
-    chainCode: string | null;
-    isProduction: boolean;
-    tokenExpiryDate?: Date | null;
-    gatewayUrl: string | null;
-    connectionSuccesful?: boolean;
-    interfaceKey?: string | null;
-    interfaceId?: string | null;
-};

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

@@ -1 +0,0 @@
-export * from './IOHIPConfiguration.types';

package/dist/types/PMSSync/EPMSSyncStatus.enum.d.ts

@@ -1,8 +0,0 @@
-export declare enum EPMSSyncStatus {
-    New = "new",
-    Queued = "queued",
-    InProgress = "in_progress",
-    Success = "success",
-    Failure = "failure",
-    RequireResume = "require_resume"
-}

package/dist/types/PMSSync/IPMSSyncResponse.type.d.ts

@@ -1,10 +0,0 @@
-import { ECompanyProvider } from '../Company/ECompanyProvider.enum';
-import { EPMSSyncStatus } from './EPMSSyncStatus.enum';
-export interface IPMSSyncResponse {
-    id: number;
-    provider: ECompanyProvider;
-    status: EPMSSyncStatus;
-    syncData: string | null;
-    syncType: string;
-    additionalData?: any;
-}

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

@@ -1,17 +0,0 @@
-export * from './EPMSSyncStatus.enum';
-export * from './IPMSSyncResponse.type';
-export declare enum ERMSAuthSyncHistoryStatus {
-    Success = "success",
-    Failure = "failure",
-    New = "new",
-    Queued = "queued",
-    InProgress = "in_progress",
-    RequireResume = "require_resume"
-}
-export type IRMSSyncResponse = {
-    id: number;
-    status: ERMSAuthSyncHistoryStatus;
-    additionalData: any;
-    syncData: string | null;
-    syncType: string;
-};

package/dist/types/Package/Package.types.d.ts

@@ -1,104 +0,0 @@
-import { IAddonPriceDetailsFee } from '../Addons/Addon.types';
-import { ICommonQueryParameters } from '../Booking/ICommonQueryParameters.type';
-import { IItemisedBookingFeeResponse } from '../Booking/Itinerary.types';
-export declare class Package {
-    /**
-     * The SynXis CR RatePlan Code associated with the Package if the Package is restricted to certain RatePlans
-     */
-    ratePlanCode?: string;
-    name: string;
-    description: string;
-    /**
-     * Whether the price for this package is included in the room rate.
-     * (Always `false` unless the price is zero)
-     */
-    inclusive: boolean;
-    image: string[];
-    url?: string;
-    /**
-     * Defines how a service is priced.
-     * Values:
-     * Per Stay
-     * Per Night
-     * Per Person
-     * Per Person Per Night
-     */
-    pricingType: string;
-    /**
-     * Number of available items for sale.
-     */
-    quantity?: number;
-    category: string;
-    cancelPenalty?: string | null;
-    guaranteeDescription?: string | null;
-    availability: {
-        [date: string]: IPriceInfo;
-    };
-}
-export declare class ReservedPackage extends Package {
-    code?: string | undefined;
-    price?: number;
-    fees?: number;
-    itemisedFees?: IItemisedBookingFeeResponse[];
-    adultQuantity?: number;
-    childQuantity?: number;
-    adultPrice?: number;
-    childPrice?: number;
-    startDate?: string;
-    startTime?: string;
-    hideDatePicker?: boolean;
-    hideQuantity?: boolean;
-    order?: number;
-    discount?: number;
-    total?: number;
-}
-export type IPriceInfo = {
-    /**
-     * Number of available items for sale.
-     */
-    quantity: number;
-    /**
-     * Price per quantity
-     */
-    price?: number;
-    adultPrice?: number;
-    childPrice?: number;
-    fees?: IAddonPriceDetailsFee[];
-    adultFees?: IAddonPriceDetailsFee[];
-    childFees?: IAddonPriceDetailsFee[];
-    timeSlots?: ITimeSlot[];
-};
-export type ITimeSlot = {
-    /**
-     The start date and time when the package is available.
-     If the package applies during the whole stay, this node is not returned unless the time needs to be selected.  In that case, the Start and End dates do not
-     include the date: @Start="T07:30:00" and @End="T17:30:00" and @Increment="00:60:00"
-     Type:  DateTime
-     **/
-    startTime?: string;
-    /**
-     The end date / time when the package is available.
-     If the package component applies during the whole stay, this node is not returned unless the time needs to be selected.  In that case, the Start and End dates
-     do not include the date: @Start="T07:30:00" and @End="T17:30:00" and @Increment="00:60:00"
-     Type:  DateTime
-     */
-    endTime?: string;
-    /**
-     Used with @Start and @End.  Indicates the interval when the package or service is available.
-     For example, a package with golf lessons from 7:30 am to 5:30 pm with instructions and available hourly has the TimeSpan attributes set as: @Start="2015-
-     010-28T07:30:00" and @End="2015-10-28T17:30:00" and @Increment="00:60:00"
-     Type:  Time
-     */
-    increment?: string;
-};
-export type IGetPackagesRequest = {
-    adults?: number;
-    children?: number;
-    checkInDate: Date;
-    checkOutDate: Date;
-    rate: string;
-    room?: string;
-} & ICommonQueryParameters;
-export type IGetPackagesResponse = {
-    [packageName: string]: ReservedPackage;
-};

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

@@ -1,6 +0,0 @@
-export declare enum EGuaranteePolicyDepositMode {
-    Full = "Full",
-    Percentage = "Percentage",
-    FirstNight = "FirstNight",
-    None = "None"
-}

package/dist/types/PromoCode/EPromoCodeDiscountType.enum.d.ts

@@ -1,5 +0,0 @@
-export declare enum EPromoCodeDiscountType {
-    FlatPercent = "flatPercent",
-    FlatQuantity = "flatQuantity",
-    FlatQuantityPerStay = "flatQuantityPerStay"
-}

package/dist/types/PromoCode/PromoCodeStayDateRangeType.enum.d.ts

@@ -1,11 +0,0 @@
-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/ERMSAuthSyncHistoryStatus.type.d.ts

@@ -1,8 +0,0 @@
-export declare enum ERMSAuthSyncHistoryStatus {
-    Success = "success",
-    Failure = "failure",
-    New = "new",
-    Queued = "queued",
-    InProgress = "in_progress",
-    RequireResume = "require_resume"
-}

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

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

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

@@ -1,39 +0,0 @@
-export declare enum ERMSSyncStrategy {
-    /**
-     * Super-admin granular sync strategies
-     */
-    Hotel = "hotel",
-    HotelImages = "hotelImages",
-    Cancellation = "cancellation",
-    Room = "room",
-    Rates = "rates",
-    OneGuaranteePolicy = "oneGuaranteePolicy",
-    RoomRates = "roomRates",
-    RoomImages = "roomImages",
-    BookingSources = "booking-sources",
-    Areas = "areas",
-    Dwellings = "dwellings",
-    AreaDwellings = "areaDwellings",
-    ConvertDwellingConfigToAuxInput = "convertDwellingConfigToAuxInput",
-    Discounts = "discounts",
-    PropertyDiscounts = "propertyDiscounts",
-    RoomDiscounts = "roomDiscounts",
-    PropertySundries = "propertySundries",
-    PropertyFees = "propertyFees",
-    PropertyCards = "property-cards",
-    Countries = "countries",
-    Addons = "addons",
-    Requirements = "requirements",
-    RoomAddons = "room-addons",
-    /**
-     * Client-facing sync strategies
-     */
-    ClientFacingPromoSync = "clientFacingPromoSync",
-    ClientFacingRoomSync = "clientFacingRoomSync",
-    ClientFacingRateSync = "clientFacingRateSync",
-    ClientFacingAreaSync = "clientFacingAreaSync",
-    /**
-     * Other sync strategies
-     */
-    NewRateFetch = "newRateFetch"
-}

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

@@ -1,33 +0,0 @@
-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;
-    };
-    nightlyRateOverride?: {
-        firstXNights: number;
-        totalCharge: number;
-        includeAdditionals: boolean;
-    };
-    availableToIbe: boolean;
-    minimumNightStay: number;
-    maximumNightStay: number;
-    availableToMembers: boolean;
-};

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

@@ -1,20 +0,0 @@
-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;
-    total: number;
-};

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

@@ -1,8 +0,0 @@
-import { ERMSAuthSyncHistoryStatus } from './ERMSAuthSyncHistoryStatus.type';
-export type IRMSSyncResponse = {
-    id: number;
-    status: ERMSAuthSyncHistoryStatus;
-    additionalData: any;
-    syncData: string | null;
-    syncType: string;
-};

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

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

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

@@ -1,18 +0,0 @@
-export type IRoomGroup = {
-    companyId: number;
-    hotelId: string;
-    id: string;
-    groupName: string;
-    displayOrder: number;
-    checkInTime: string | null;
-    checkOutTime: string | null;
-    /** this will be a list of room codes */
-    rooms: string[];
-    auxiliaryFilters: {
-        [id: string]: {
-            enabled: boolean;
-            requireSelection: boolean;
-        };
-    };
-    deletedDate?: Date;
-};

package/dist/utils/TotalCalculator.d.ts

@@ -1,72 +0,0 @@
-import { BasketAddonDTO } from '../types/Addons/Addon.types';
-import { ReservationAddonDTO, ReservationsDTO } from '../types/Api/Reservations.type';
-/**
- * A utility class to perform calculations related to addon pricing and reservation totals.
- */
-export declare class TotalCalculator {
-    /**
-     * Calculates the base total cost for a single addon, without considering any additional fees.
-     *
-     * @param addon - A `BasketAddonDTO` or `ReservationAddonDTO` representing the addon details.
-     * @param dismissAddonNightCount - If true, skips multiplying totals by the number of nights.
-     * @returns An object containing:
-     * - `indPrice`: Total price without per adult/child pricing.
-     * - `indAdultPrice`: Price calculated based on adult quantities.
-     * - `indChildPrice`: Price calculated based on child quantities.
-     * - `addonTotal`: Sum of the above prices, optionally multiplied by nights.
-     */
-    static calculateBaseAddonTotal: (addon: Partial<BasketAddonDTO> | Partial<ReservationAddonDTO>, dismissAddonNightCount: boolean) => {
-        indPrice: number;
-        indAdultPrice: number;
-        indChildPrice: number;
-        addonTotal: number;
-    };
-    /**
-     * Calculates the total for one or more basket addons, including all associated fees.
-     *
-     * @param addons - A single or an array of `BasketAddonDTO` objects.
-     * @param dismissAddonNightCount - If true, disables night-based multiplier for addons.
-     * @returns An object with:
-     * - `price`: Total base price (excluding adult/child prices).
-     * - `adultPrice`: Total based on adult quantities and prices.
-     * - `childPrice`: Total based on child quantities and prices.
-     * - `totalFees`: Total of all applicable addon fees.
-     * - `total`: Sum of prices and fees.
-     */
-    static calculateBasketAddonTotal: (addons: BasketAddonDTO | BasketAddonDTO[], dismissAddonNightCount?: boolean) => {
-        price: number;
-        adultPrice: number;
-        childPrice: number;
-        totalFees: number;
-        total: number;
-    };
-    /**
-     * Calculates the total for one or more reservation addons, including itemised fees.
-     *
-     * @param addons - A single or an array of `ReservationAddonDTO` objects.
-     * @param dismissAddonNightCount - If true, disables night-based multiplier for addons.
-     * @returns An object with:
-     * - `price`: Base addon price without adult/child multipliers.
-     * - `adultPrice`: Addon cost based on adult rates.
-     * - `childPrice`: Addon cost based on child rates.
-     * - `totalFees`: Total of all fees (itemised if available).
-     * - `total`: Final addon cost including fees.
-     * - `displayPrice`: Price displayed to the user (varies depending on fee breakdown).
-     */
-    static calculateReservationAddonTotal: (addons: ReservationAddonDTO | ReservationAddonDTO[], dismissAddonNightCount?: boolean) => {
-        price: number;
-        adultPrice: number;
-        childPrice: number;
-        totalFees: number;
-        total: number;
-        displayPrice: number;
-    };
-    /**
-     * Calculates the total cost for a reservation, including individual reservation totals and global itemised fees.
-     *
-     * @param reservation - The full reservation data in `ReservationsDTO` format.
-     * @param dismissAddonNightCount - If true, disables night-based multipliers on addons.
-     * @returns The rounded total cost of the reservation.
-     */
-    static calculateTotalForReservation: (reservation: ReservationsDTO, dismissAddonNightCount?: boolean) => number;
-}

package/dist/utils/bookingTotal.d.ts

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

package/dist/utils/calculateFee.d.ts

@@ -1,10 +0,0 @@
-import { IFee } from '../types/index.js';
-interface FeeCalculationParams {
-    baseAmount?: number;
-    numberOfNights?: number;
-    feeIncludedInBaseAmount?: boolean;
-    extractedFromRates?: boolean;
-    removedPercentages?: number[];
-}
-export declare function calculateFeeAmount(fee: IFee, params?: FeeCalculationParams): number;
-export {};

package/dist/utils/feeTypes.d.ts

@@ -1,5 +0,0 @@
-import { EFeeType, IFee, IFeeConfigurationOptions } from '../types/index.js';
-export declare function getFilteredBookingFees<T extends IFee>(fees: T[]): T[];
-export declare function getFilteredBookingRateFees<T extends IFee>(fees: T[]): T[];
-export declare function getFilteredBookingAddonFees<T extends IFee>(fees: T[]): T[];
-export declare function getFeeOptionValidity(feeType: EFeeType): Record<keyof IFeeConfigurationOptions, boolean>;