@roomstay/core 0.1.85-4 → 0.1.85-5

package/dist/node.js.LICENSE.txt

@@ -0,0 +1,7 @@
+/*!
+ *  decimal.js v10.4.3
+ *  An arbitrary-precision Decimal type for JavaScript.
+ *  https://github.com/MikeMcl/decimal.js
+ *  Copyright (c) 2022 Michael Mclaughlin <M8ch88l@gmail.com>
+ *  MIT Licence
+ */

package/dist/types/Analytics/IAnalyticsDailyRow.type.d.ts

@@ -5,6 +5,7 @@ export interface IAnalyticsDailyRow {
     revenue: number;
     cost: number;
     impressions: number;
+    currency: string;
 }
 export interface IAnalyticsWithComparison<T extends IAnalyticsDailyRow = IAnalyticsDailyRow> {
     current: T[];

package/dist/types/Analytics/IAnalyticsEvent.type.d.ts

@@ -0,0 +1,35 @@
+export type AnalyticsEventName = 'AddToCart' | 'InitiateCheckout' | 'Purchase';
+export interface IAnalyticsEventData {
+    currency: string;
+    value: number;
+    contentIds?: string[];
+    contentType?: string;
+    contents?: Array<{
+        id: string;
+        quantity: number;
+        itemPrice: number;
+    }>;
+    numItems?: number;
+}
+export interface IAnalyticsUserData {
+    email?: string;
+    phone?: string;
+    firstName?: string;
+    lastName?: string;
+    city?: string;
+    state?: string;
+    zipCode?: string;
+    country?: string;
+    externalId?: string;
+}
+export interface IAnalyticsEvent {
+    eventId: string;
+    sessionId: string;
+    hotelId: string;
+    eventName: AnalyticsEventName;
+    eventTime: number;
+    eventData: IAnalyticsEventData;
+    userData?: IAnalyticsUserData;
+    createdAt: number;
+    ttl: number;
+}

package/dist/types/Analytics/IAnalyticsSession.type.d.ts

@@ -0,0 +1,11 @@
+export interface IAnalyticsSession {
+    sessionId: string;
+    hotelId: string;
+    fbc?: string;
+    fbp?: string;
+    externalId?: string;
+    userAgent?: string;
+    ipAddress?: string;
+    createdAt: number;
+    ttl: number;
+}

package/dist/types/Analytics/IBigQueryResponse.type.d.ts

@@ -0,0 +1,24 @@
+export type IDailyRevenue = {
+    date: string;
+    revenue: number;
+};
+export type IDailyRoomBreakdown = {
+    date: string;
+    roomName: string;
+    purchases: number;
+};
+export type IRegionBreakdown = {
+    country: string;
+    region: string;
+    purchases: number;
+    revenue: number;
+};
+export type IBigQueryResponse = {
+    purchases: number;
+    cancellations: number;
+    revenue: number;
+    conversionRate: number;
+    dailyRevenue: IDailyRevenue[];
+    dailyRoomsBreakdown: IDailyRoomBreakdown[];
+    regionBreakdown: IRegionBreakdown[];
+};

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

@@ -0,0 +1,89 @@
+import { EHotelCardProcessor } from './IBookingPayment.type';
+export declare enum ESplitPaymentState {
+    INITIATED = "initiated",
+    GIFTCARD_AUTHORIZED = "giftcard_authorized",
+    CC_AUTHORIZED = "cc_authorized",
+    CAPTURED = "captured",
+    FAILED = "failed",
+    ROLLED_BACK = "rolled_back"
+}
+export declare enum ESplitPaymentStatus {
+    PENDING = "pending",
+    AUTHORIZED = "authorized",
+    CAPTURED = "captured",
+    FAILED = "failed"
+}
+export interface IGiftCardPaymentDetails {
+    amount: number;
+    cardCode: string;
+    authorizationId?: string;
+    status: ESplitPaymentStatus;
+    expiresAt?: Date;
+}
+export interface ICreditCardPaymentDetails {
+    amount: number;
+    processor: EHotelCardProcessor;
+    authorizationId?: string;
+    status: ESplitPaymentStatus;
+    expiresAt?: Date;
+}
+export interface ISplitPayment {
+    splitPaymentId: string;
+    totalAmount: number;
+    giftCard: IGiftCardPaymentDetails;
+    creditCard: ICreditCardPaymentDetails;
+    sessionState: ESplitPaymentState;
+    createdAt: Date;
+    updatedAt: Date;
+    expiresAt: Date;
+}
+export interface ISplitPaymentSession {
+    id: string;
+    bookingId: number;
+    companyId: number;
+    hotelId: string;
+    splitPayment: ISplitPayment;
+}
+export interface IInitiateSplitPaymentRequest {
+    bookingId: number;
+    giftCardCode: string;
+    giftCardAmount: number;
+    creditCardAmount: number;
+}
+export interface IInitiateSplitPaymentResponse {
+    sessionId: string;
+    giftCardAmount: number;
+    creditCardAmount: number;
+    expiresAt: Date;
+}
+export interface IAuthorizationResult {
+    success: boolean;
+    authorizationId?: string;
+    expiresAt?: Date;
+    error?: string;
+}
+export interface ICaptureResult {
+    success: boolean;
+    giftCardCaptured: boolean;
+    creditCardCaptured: boolean;
+    error?: string;
+}
+export interface ISplitPaymentCheckoutDetails {
+    sessionId: string;
+    currentStep: 'giftcard' | 'creditcard' | 'capture';
+    giftCard: {
+        amount: number;
+        status: ESplitPaymentStatus;
+        authorizationId?: string;
+        expiresAt?: Date;
+    };
+    creditCard: {
+        amount: number;
+        status: ESplitPaymentStatus;
+        processor?: EHotelCardProcessor;
+        redirectUrl?: string;
+        authorizationId?: string;
+        expiresAt?: Date;
+    };
+    expiresAt: Date;
+}

package/dist/types/DisplayPolicy/EDisplayPolicyRuleType.enum.d.ts

@@ -2,5 +2,5 @@ export declare enum EDisplayPolicyRuleType {
     Schedule = "Schedule",
     DeviceTarget = "DeviceTarget",
     GeoLock = "GeoLock",
-    Exclusive = "Exclusive"
+    CheapestOf = "CheapestOf"
 }

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

@@ -0,0 +1,6 @@
+export interface IFeeOptions {
+    includeInRates: boolean;
+    alreadyIncludedInRates: boolean;
+    appliesToAddons: boolean;
+    includePreviousFeesInCalculation: boolean;
+}

package/dist/types/Member/LoyaltyTiers.d.ts

@@ -0,0 +1,6 @@
+export interface ILoyaltyTier {
+    /** Spending threshold in cents */
+    threshold: number;
+    /** Discount percentage awarded at this tier */
+    discountPercent: number;
+}

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

@@ -0,0 +1,4 @@
+export declare enum ENewbookSiteSelectionFeeType {
+    PerNight = "per_night",
+    PerBooking = "per_booking"
+}

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

@@ -0,0 +1,6 @@
+export declare enum ENewbookSiteSelectionType {
+    PmsAndNbo = "pms_and_nbo",
+    Pms = "pms",
+    Nbo = "nbo",
+    NoFee = "no_fee"
+}

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

@@ -0,0 +1,3 @@
+export declare enum ENewbookSyncType {
+    Rates = "rates"
+}

package/dist/types/Newbook/INewbookSyncResponse.type.d.ts

@@ -0,0 +1,9 @@
+import { EPMSSyncStatus } from '../PMS/EPMSSyncStatus.enum';
+import { ENewbookSyncStrategy } from './ENewbookSyncStrategy.enum';
+export interface INewbookSyncResponse {
+    id: number;
+    status: EPMSSyncStatus;
+    syncData: string | null;
+    syncType: ENewbookSyncStrategy;
+    additionalData?: any;
+}

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

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

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

@@ -0,0 +1,10 @@
+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/PMS/index.d.ts

@@ -0,0 +1,2 @@
+export * from './EPMSSyncStatus.enum';
+export * from './IPMSSyncResponse.type';

package/dist/web.js.LICENSE.txt

@@ -0,0 +1,7 @@
+/*!
+ *  decimal.js v10.4.3
+ *  An arbitrary-precision Decimal type for JavaScript.
+ *  https://github.com/MikeMcl/decimal.js
+ *  Copyright (c) 2022 Michael Mclaughlin <M8ch88l@gmail.com>
+ *  MIT Licence
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@roomstay/core",
-    "version": "0.1.85-4",
+    "version": "0.1.85-5",
     "description": "Details shared between Roomstay libraries. Anything from Currency, to Generic types",
     "types": "./dist/index.d.ts",
     "files": [

package/dist/types/DisplayPolicy/ERuleType.d.ts

@@ -1,6 +0,0 @@
-export declare enum ERuleType {
-    Schedule = "Schedule",
-    DeviceTarget = "DeviceTarget",
-    GeoLock = "GeoLock",
-    CheapestOf = "CheapestOf"
-}

package/dist/types/DisplayPolicy/ERuleType.enum.d.ts

@@ -1,6 +0,0 @@
-export declare enum ERuleType {
-    Schedule = "Schedule",
-    DeviceTarget = "DeviceTarget",
-    GeoLock = "GeoLock",
-    CheapestOf = "CheapestOf"
-}

package/dist/types/DisplayPolicy/IDisplayPolicy.d.ts

@@ -1,25 +0,0 @@
-import { ERuleType } from './ERuleType';
-export interface IDisplayPolicy {
-    id: number;
-    name: string;
-    description: string;
-    applicableRates: string[];
-    conditions: ICondition[];
-}
-export type IScheduleConfiguration = {
-    rruleSet: string;
-    durationMs: number;
-};
-export type ICondition = {
-    ruleType: ERuleType.Schedule;
-    configuration: IScheduleConfiguration;
-} | {
-    ruleType: ERuleType.DeviceTarget;
-    configuration: unknown;
-} | {
-    ruleType: ERuleType.GeoLock;
-    configuration: unknown;
-} | {
-    ruleType: ERuleType.CheapestOf;
-    configuration: unknown;
-};

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

@@ -1,34 +0,0 @@
-import { ERMSDiscountType } from './ERMSDiscountType.enum';
-import { IRuleSpec } from '../Rule/IRuleConfigurations.type';
-export type IRMSDiscount = {
-    name: 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;
-    rules: IRuleSpec[];
-};

package/dist/types/Rule/EDayOfWeek.enum.d.ts

@@ -1,9 +0,0 @@
-export declare enum EDayOfWeek {
-    MON = "MON",
-    TUE = "TUE",
-    WED = "WED",
-    THU = "THU",
-    FRI = "FRI",
-    SAT = "SAT",
-    SUN = "SUN"
-}

package/dist/types/Rule/EDisplayPolicyEffectType.enum.d.ts

@@ -1,11 +0,0 @@
-export declare enum EDisplayPolicyEffectType {
-    Visibility = "visibility",
-    Exclusivity = "exclusivity"
-}
-export declare enum EDisplayPolicyExclusivityMode {
-    Cheapest = "cheapest",
-    MostExpensive = "most_expensive"
-}
-export interface IDisplayPolicyExclusivityConfiguration {
-    mode: EDisplayPolicyExclusivityMode;
-}

package/dist/types/Rule/ERuleType.enum.d.ts

@@ -1,11 +0,0 @@
-export declare enum ERuleType {
-    Schedule = "Schedule",
-    GeoLock = "GeoLock",
-    DeviceTarget = "DeviceTarget",
-    DayOfWeek = "DayOfWeek",
-    HotelRestriction = "HotelRestriction",
-    RoomRestriction = "RoomRestriction",
-    RateRestriction = "RateRestriction",
-    NightCount = "NightCount",
-    AnyOf = "AnyOf"
-}

package/dist/types/Rule/IRule.type.d.ts

@@ -1 +0,0 @@
-export type { IRuleSpec } from './IRuleConfigurations.type';

package/dist/types/Rule/IRuleConfigurations.type.d.ts

@@ -1,68 +0,0 @@
-import { EDayOfWeek } from './EDayOfWeek.enum';
-import { ERuleType } from './ERuleType.enum';
-export interface IScheduleConfig {
-    type: 'clock' | 'stay';
-    rules: Array<{
-        type: 'include' | 'exclude';
-        startDate: string;
-        endDate: string;
-        rrule?: string;
-    }>;
-}
-export interface IGeoLockConfig {
-    applicableCountryCodes: string[];
-    mode: 'allow' | 'deny';
-}
-export type TDeviceTarget = 'mobile' | 'desktop';
-export interface IDeviceTargetConfig {
-    allowedDevices: TDeviceTarget[];
-}
-export type TDayOfWeekSource = 'arrival' | 'night' | 'booking';
-export interface IDayOfWeekConfig {
-    source: TDayOfWeekSource;
-    allowedDays: EDayOfWeek[];
-}
-export interface IHotelRestrictionConfig {
-    hotelIds: string[];
-}
-export interface IRoomRestrictionConfig {
-    roomCodes: string[];
-}
-export interface IRateRestrictionConfig {
-    rateCodes: string[];
-}
-export interface INightCountConfig {
-    min?: number;
-    max?: number;
-}
-export interface IAnyOfConfig {
-    branches: IRuleSpec[][];
-}
-export type IRuleSpec = {
-    ruleType: ERuleType.Schedule;
-    configuration: IScheduleConfig;
-} | {
-    ruleType: ERuleType.GeoLock;
-    configuration: IGeoLockConfig;
-} | {
-    ruleType: ERuleType.DeviceTarget;
-    configuration: IDeviceTargetConfig;
-} | {
-    ruleType: ERuleType.DayOfWeek;
-    configuration: IDayOfWeekConfig;
-} | {
-    ruleType: ERuleType.HotelRestriction;
-    configuration: IHotelRestrictionConfig;
-} | {
-    ruleType: ERuleType.RoomRestriction;
-    configuration: IRoomRestrictionConfig;
-} | {
-    ruleType: ERuleType.RateRestriction;
-    configuration: IRateRestrictionConfig;
-} | {
-    ruleType: ERuleType.NightCount;
-    configuration: INightCountConfig;
-} | {
-    ruleType: ERuleType.AnyOf;
-    configuration: IAnyOfConfig;
-};

package/dist/types/Rule/IRuleContext.type.d.ts

@@ -1,13 +0,0 @@
-export interface IRuleContextDescriptor {
-    hasHotel: true;
-    hasNow: true;
-    optional: {
-        checkInDate?: true;
-        checkOutDate?: true;
-        nightDate?: true;
-        event?: true;
-        geolocation?: true;
-        rateCode?: true;
-        roomCode?: true;
-    };
-}

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

@@ -1,4 +0,0 @@
-export * from './EDayOfWeek.enum';
-export * from './EDisplayPolicyEffectType.enum';
-export * from './ERuleType.enum';
-export * from './IRuleConfigurations.type';