@roomstay/core 0.2.0-9 → 0.2.0

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

@@ -1,4 +1,5 @@
 export type IMaintenanceStatus = {
+    uuid: string;
     /**
      * Which service is currently experiencing issues.
      */
@@ -9,10 +10,6 @@ export type IMaintenanceStatus = {
      * @example 2023-10-01T00:00:00Z
      */
     startDate: string;
-    /**
-     * UUID generated on create. Is not used as a primary key, or an index.
-     */
-    uuid: string;
     endDate: string;
     /**
      * Whether the status is currently in effect or not

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

@@ -7,7 +7,4 @@ export interface IMemberVerification {
     firstName?: string;
     email?: string;
     password?: string;
-    postalCode?: string;
-    mobilePhone?: string;
-    marketingOptIn?: string;
 }

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

@@ -1,4 +1,4 @@
-import { IRoomstayCognitoMember, IRoomstayMemberBooking, IRoomstayMemberCards, IRoomstayMemberLoyalty } from '../index.js';
+import { IRoomstayCognitoMember, IRoomstayMemberBooking, IRoomstayMemberCards } from '../index.js';
 export interface IRoomstayMember extends IRoomstayCognitoMember {
     username: string;
     email: string;
@@ -15,5 +15,4 @@ export interface IRoomstayMember extends IRoomstayCognitoMember {
     defaultCard: string;
     bookings: IRoomstayMemberBooking[];
     cards: IRoomstayMemberCards[];
-    loyalty?: IRoomstayMemberLoyalty[];
 }

package/dist/types/MetaAds/IMetaAdsDailyRow.type.d.ts

@@ -0,0 +1,4 @@
+import { IAnalyticsDailyRow } from '../Analytics/IAnalyticsDailyRow.type';
+export interface IMetaAdsDailyRow extends IAnalyticsDailyRow {
+    campaign: string;
+}

package/dist/types/Metasearch/IMetasearchDailyRow.type.d.ts

@@ -0,0 +1,8 @@
+import { IAnalyticsDailyRow } from '../Analytics/IAnalyticsDailyRow.type';
+export interface IMetasearchDailyRow extends IAnalyticsDailyRow {
+    hotelId: string;
+    channel: string;
+    linkType: string;
+    deviceType: string;
+    market: string;
+}

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

@@ -1,7 +1,6 @@
 export declare enum ENewbookSyncStrategy {
     Rates = "rates",
     Rooms = "rooms",
-    Availability = "availability",
     Details = "details",
     Tariffs = "tariffs",
     Discounts = "discounts",

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

@@ -1,17 +1,2 @@
 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

@@ -36,6 +36,7 @@ export declare class Package {
     };
 }
 export declare class ReservedPackage extends Package {
+    addonId?: string;
     code?: string | undefined;
     price?: number;
     fees?: number;

package/dist/types/Permission/IPermission.type.d.ts

@@ -0,0 +1,152 @@
+export type IPermission = {
+    id: number;
+    name: string;
+    label: string;
+    group: string;
+    deletedDate?: string;
+};
+export declare function getAllPermissions(): readonly Omit<IPermission, 'id'>[];
+export declare function getAllLimitedPermissions(): readonly Omit<IPermission, 'id'>[];
+export declare const Permissions: {
+    readonly USER_VIEW: {
+        readonly name: "user:view";
+        readonly label: "View User";
+        readonly group: "User Management";
+    };
+    readonly USER_MODIFY: {
+        readonly name: "user:modify";
+        readonly label: "Modify User";
+        readonly group: "User Management";
+    };
+    readonly ROLE_VIEW: {
+        readonly name: "role:view";
+        readonly label: "View Role";
+        readonly group: "User Management";
+    };
+    readonly ROLE_MODIFY: {
+        readonly name: "role:modify";
+        readonly label: "Modify Role";
+        readonly group: "User Management";
+    };
+    readonly HOTEL_MODIFY: {
+        readonly name: "hotel:modify";
+        readonly label: "Modify Hotel";
+        readonly group: "Property Configuration";
+    };
+    readonly HOTEL_INTEGRATIONS: {
+        readonly name: "hotelIntegrations:modify";
+        readonly label: "Modify Hotel Integrations";
+        readonly group: "Property Configuration";
+    };
+    readonly FEE_VIEW: {
+        readonly name: "fee:view";
+        readonly label: "View Fee";
+        readonly group: "Property Configuration";
+    };
+    readonly FEE_MODIFY: {
+        readonly name: "fee:modify";
+        readonly label: "Modify Fee";
+        readonly group: "Property Configuration";
+    };
+    readonly GUARANTEE_POLICIES_VIEW: {
+        readonly name: "guaranteePolicies:view";
+        readonly label: "View Guarantee Policies";
+        readonly group: "Policy Management";
+    };
+    readonly GUARANTEE_POLICIES_MODIFY: {
+        readonly name: "guaranteePolicies:modify";
+        readonly label: "Modify Guarantee Policies";
+        readonly group: "Policy Management";
+    };
+    readonly CANCELLATION_POLICIES_VIEW: {
+        readonly name: "cancellationPolicies:view";
+        readonly label: "View Cancellation Policies";
+        readonly group: "Policy Management";
+    };
+    readonly CANCELLATION_POLICIES_MODIFY: {
+        readonly name: "cancellationPolicies:modify";
+        readonly label: "Modify Cancellation Policies";
+        readonly group: "Policy Management";
+    };
+    readonly ROOM_VIEW: {
+        readonly name: "room:view";
+        readonly label: "View Room";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly ROOM_MODIFY: {
+        readonly name: "room:modify";
+        readonly label: "Modify Room";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly ROOM_GROUPING_VIEW: {
+        readonly name: "roomGrouping:view";
+        readonly label: "View Room Grouping";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly ROOM_GROUPING_MODIFY: {
+        readonly name: "roomGrouping:modify";
+        readonly label: "Modify Room Grouping";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly RATE_VIEW: {
+        readonly name: "rate:view";
+        readonly label: "View Rate";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly RATE_MODIFY: {
+        readonly name: "rate:modify";
+        readonly label: "Modify Rate";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly ADDON_VIEW: {
+        readonly name: "addon:view";
+        readonly label: "View Addon";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly ADDON_MODIFY: {
+        readonly name: "addon:modify";
+        readonly label: "Modify Addon";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly PROMO_CODE_VIEW: {
+        readonly name: "promoCode:view";
+        readonly label: "View Promo Code";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly PROMO_CODE_MODIFY: {
+        readonly name: "promoCode:modify";
+        readonly label: "Modify Promo Code";
+        readonly group: "Room, Rate and Addon Management";
+    };
+    readonly BOOKING_VIEW: {
+        readonly name: "booking:view";
+        readonly label: "View Booking";
+        readonly group: "Booking Management";
+    };
+    readonly BOOKING_EXPORT: {
+        readonly name: "booking:export";
+        readonly label: "Export Booking";
+        readonly group: "Booking Management";
+    };
+    readonly EVENTS_VIEW: {
+        readonly name: "events:view";
+        readonly label: "View Event";
+        readonly group: "Events and Calendar Highlights";
+    };
+    readonly EVENTS_MODIFY: {
+        readonly name: "events:modify";
+        readonly label: "Modify Event";
+        readonly group: "Events and Calendar Highlights";
+    };
+    readonly CALENDAR_HIGHLIGHTS_VIEW: {
+        readonly name: "calendarHighlights:view";
+        readonly label: "View Calendar Highlight";
+        readonly group: "Events and Calendar Highlights";
+    };
+    readonly CALENDAR_HIGHLIGHTS_MODIFY: {
+        readonly name: "calendarHighlights:modify";
+        readonly label: "Modify Calendar Highlight";
+        readonly group: "Events and Calendar Highlights";
+    };
+};
+export type PermissionType = typeof Permissions[keyof typeof Permissions];

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

@@ -4,8 +4,3 @@ export declare enum EGuaranteePolicyDepositMode {
     FirstNight = "FirstNight",
     None = "None"
 }
-export declare enum EGuarantyPolicyPrepaymentType {
-    FixedAmount = "fixed",
-    Percentage = "percentage",
-    Nights = "nights"
-}

package/dist/types/Role/IRole.type.d.ts

@@ -0,0 +1,15 @@
+import { IPermission } from '../Permission/IPermission.type';
+import { IAdminCompany } from '../Company/IAdminCompany.type';
+export interface IRole {
+    id: number;
+    companyId: IAdminCompany['id'];
+    name: string;
+    totalPermissions?: number;
+    permissions?: IPermission[];
+    deletedDate?: string;
+}
+export interface IRolePayload {
+    id: number;
+    name: string;
+    permissionIds?: IPermission['id'][];
+}

package/dist/types/Rules/DisplayPolicyEffect.schema.d.ts

@@ -0,0 +1,22 @@
+import * as z from 'zod';
+import { EDisplayPolicyExclusiveMode } from '../DisplayPolicy/IDisplayPolicy.type';
+/**
+ * Every DisplayPolicy has *rules* (predicates that gate when it applies) and an *effect*
+ * (what it does to its bound rates):
+ *
+ * - `visibility`  — show the bound rates only when the rules pass (no config needed).
+ * - `exclusivity` — show only the cheapest / most expensive of the bound rates.
+ */
+export type EDisplayPolicyEffectType = 'visibility' | 'exclusivity';
+export declare const DISPLAY_POLICY_EFFECT_TYPES: EDisplayPolicyEffectType[];
+export declare const EDisplayPolicyEffectTypeSchema: z.ZodEnum<{
+    visibility: "visibility";
+    exclusivity: "exclusivity";
+}>;
+export declare const ExclusivityEffectConfigSchema: z.ZodObject<{
+    mode: z.ZodEnum<{
+        Cheapest: EDisplayPolicyExclusiveMode.Cheapest;
+        MostExpensive: EDisplayPolicyExclusiveMode.MostExpensive;
+    }>;
+}, z.core.$strip>;
+export type IExclusivityEffectConfig = z.infer<typeof ExclusivityEffectConfigSchema>;

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

@@ -0,0 +1,19 @@
+/**
+ * The shared library of reusable Rules — predicates over a context, written once
+ * and used by every subject (DisplayPolicy rate visibility, RMS discount applicability,
+ * PromoCode eligibility).
+ *
+ * `AnyOf` = OR (`.some`), `AllOf` = AND (`.every`); both are shaped `{ rules: IRule[] }`.
+ * The top-level rule list of any subject is an implicit root AND.
+ */
+export declare enum ERuleType {
+    Schedule = "Schedule",
+    GeoLock = "GeoLock",
+    DeviceTarget = "DeviceTarget",
+    HotelRestriction = "HotelRestriction",
+    RoomRestriction = "RoomRestriction",
+    RateRestriction = "RateRestriction",
+    StayLength = "StayLength",
+    AnyOf = "AnyOf",
+    AllOf = "AllOf"
+}

package/dist/types/Rules/Rule.schema.d.ts

@@ -0,0 +1,124 @@
+import * as z from 'zod';
+import { EDisplayPolicyDeviceTarget } from '../DisplayPolicy/IDisplayPolicy.type';
+import { ERuleType } from './ERuleType.enum';
+/**
+ * Which date a Schedule rule's windows test.
+ *
+ * - `bookingTime` → `hotel.now()` (the moment the booking is being made)
+ * - `arrivalDate` → the stay's check-in date
+ * - `stayDates`   → a single night under test (per-night pass only)
+ *
+ * `mode` replaces the legacy `type: 'clock' | 'stay'` field, which collided with the
+ * per-window `type: 'include' | 'exclude'` and misleadingly called the arrival date "stay".
+ */
+export declare enum EScheduleMode {
+    BookingTime = "bookingTime",
+    ArrivalDate = "arrivalDate",
+    StayDates = "stayDates"
+}
+export declare const ScheduleWindowSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        include: "include";
+        exclude: "exclude";
+    }>;
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    rrule: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const ScheduleConfigSchema: z.ZodObject<{
+    mode: z.ZodEnum<{
+        bookingTime: EScheduleMode.BookingTime;
+        arrivalDate: EScheduleMode.ArrivalDate;
+        stayDates: EScheduleMode.StayDates;
+    }>;
+    rules: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            include: "include";
+            exclude: "exclude";
+        }>;
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+        rrule: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const GeoLockConfigSchema: z.ZodObject<{
+    applicableCountryCodes: z.ZodArray<z.ZodString>;
+    mode: z.ZodEnum<{
+        block: "block";
+        allow: "allow";
+    }>;
+}, z.core.$strip>;
+export declare const DeviceTargetConfigSchema: z.ZodObject<{
+    allowedDevices: z.ZodArray<z.ZodEnum<{
+        desktop: EDisplayPolicyDeviceTarget.Desktop;
+        mobile: EDisplayPolicyDeviceTarget.Mobile;
+    }>>;
+}, z.core.$strip>;
+export declare const HotelRestrictionConfigSchema: z.ZodObject<{
+    providerIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export declare const RoomRestrictionConfigSchema: z.ZodObject<{
+    roomCodes: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export declare const RateRestrictionConfigSchema: z.ZodObject<{
+    rateCodes: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export declare const StayLengthConfigSchema: z.ZodObject<{
+    minNights: z.ZodOptional<z.ZodNumber>;
+    maxNights: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type IScheduleConfig = z.infer<typeof ScheduleConfigSchema>;
+export type IScheduleWindow = z.infer<typeof ScheduleWindowSchema>;
+export type IGeoLockConfig = z.infer<typeof GeoLockConfigSchema>;
+export type IDeviceTargetConfig = z.infer<typeof DeviceTargetConfigSchema>;
+export type IHotelRestrictionConfig = z.infer<typeof HotelRestrictionConfigSchema>;
+export type IRoomRestrictionConfig = z.infer<typeof RoomRestrictionConfigSchema>;
+export type IRateRestrictionConfig = z.infer<typeof RateRestrictionConfigSchema>;
+export type IStayLengthConfig = z.infer<typeof StayLengthConfigSchema>;
+/** `AnyOf`/`AllOf` config: a nested rule list. `AnyOf` = OR, `AllOf` = AND. */
+export interface ICompositeConfig {
+    rules: IRule[];
+}
+/**
+ * The canonical rule — a discriminated union that ties each `ruleType` to its config shape,
+ * so constructing a rule with the wrong configuration is a compile error. Use this everywhere
+ * rules are *built* (the RMS sync mapper, the write path).
+ */
+export type IRule = {
+    ruleType: ERuleType.Schedule;
+    configuration: IScheduleConfig;
+} | {
+    ruleType: ERuleType.GeoLock;
+    configuration: IGeoLockConfig;
+} | {
+    ruleType: ERuleType.DeviceTarget;
+    configuration: IDeviceTargetConfig;
+} | {
+    ruleType: ERuleType.HotelRestriction;
+    configuration: IHotelRestrictionConfig;
+} | {
+    ruleType: ERuleType.RoomRestriction;
+    configuration: IRoomRestrictionConfig;
+} | {
+    ruleType: ERuleType.RateRestriction;
+    configuration: IRateRestrictionConfig;
+} | {
+    ruleType: ERuleType.StayLength;
+    configuration: IStayLengthConfig;
+} | {
+    ruleType: ERuleType.AnyOf;
+    configuration: ICompositeConfig;
+} | {
+    ruleType: ERuleType.AllOf;
+    configuration: ICompositeConfig;
+};
+/**
+ * A persisted / dynamically-edited rule row whose `configuration` hasn't been validated yet
+ * (a JSON DB column, an HTTP body, an admin field-array row). Narrow it to {@link IRule} with
+ * {@link RuleSchema}.parse — parse returns the typed value, so narrowing never needs a cast.
+ */
+export type IStoredRule = {
+    ruleType: ERuleType;
+    configuration: unknown;
+};
+export declare const RuleSchema: z.ZodType<IRule>;

package/dist/types/index.d.ts

@@ -22,6 +22,10 @@ export * from './Booking/PlaceBooking.types';
 export * from './Company/ECompanyProvider.enum';
 export * from './Company/IAdminCompany.type';
 export * from './Company/IAdminCompanyUser.type';
+/**
+ * Media
+ */
+export * from './Media/IMedia.type';
 /**
  * Hotel
  */
@@ -79,7 +83,6 @@ export * from './Member/IRoomstayMemberBookingItem.type';
 export * from './Member/IRoomstayMemberBookingProfile.type';
 export * from './Member/IRoomstayMemberCards.type';
 export * from './Member/IRoomstayMemberJWTData.type';
-export * from './Member/IRoomstayMemberLoyalty.type';
 export * from './Member/ISession.type';
 export * from './Member/EMembershipProvider.type';
 /**
@@ -118,15 +121,11 @@ export * from './Media/IMedia.type';
 export * from './Fees/EFeeType.enum';
 export * from './Fees/IFee.type';
 export * from './Fees/IFeeConfigurationOptions.type';
-/**
- * Api
- */
-export * from './Api/Reservations.type';
-export * from './Api/RoomNightRate.type';
 /**
  * Analytics
  */
 export * from './Analytics/IBigQueryResults.type';
+export * from './Analytics/IAnalyticsDailyRow.type';
 /**
  * Analytics Events
  */
@@ -134,11 +133,6 @@ export * from './AnalyticsEvents/IAnalyticsEvent.type';
 export * from './AnalyticsEvents/IAnalyticsSession.type';
 export * from './AnalyticsEvents/IRoomstayEventData.type';
 export * from './AnalyticsEvents/MetaCapiTransformer';
-/**
- * Gift Cards
- */
-export * from './GiftCards/GiftCard.types';
-export * from './GiftCards/GiftCardAuth.types';
 /**
  * Addons
  */
@@ -160,3 +154,15 @@ export * from './GiftCards/GiftCardLogs.enum';
  */
 export * from './DisplayPolicy/IDisplayPolicy.type';
 export * from './DisplayPolicy/EDisplayPolicyRuleType.enum';
+/**
+ * Metasearch
+ */
+export * from './Metasearch/IMetasearchDailyRow.type';
+/**
+ * Google Ads
+ */
+export * from './GoogleAds/IGoogleAdsDailyRow.type';
+/**
+ * Meta Ads
+ */
+export * from './MetaAds/IMetaAdsDailyRow.type';

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;