@vibe-flats/booking-engine-common-server 1.0.156 → 1.0.158

package/build/src/models/units.d.ts

@@ -6,6 +6,39 @@ import { MarketDocument } from './markets';
 import { GuestDocument } from './guests';
 export type UnitReviewCategory = 'cleanliness' | 'communication' | 'checkin' | 'accuracy' | 'location' | 'value' | 'service';
 export type UnitReviewPlatform = 'direct' | 'airbnb' | 'vrbo' | 'booking' | 'expedia';
+export type UnitReviewChannel = 'all' | 'airbnb' | 'booking' | 'vrbo';
+export interface UnitReview {
+    body: string;
+    isPublic: boolean;
+    isPublicOnChannel: boolean;
+    rating: number;
+    nativeRating?: number;
+    nativeScale?: 5 | 10;
+    createdAt: Date;
+    reservationId?: string;
+    externalId: string;
+    platform: UnitReviewPlatform;
+    guest: GuestDocument;
+    categories: {
+        name: UnitReviewCategory;
+        rating: number;
+    }[];
+}
+export interface UnitRatingBucket {
+    rating: number;
+    count: number;
+}
+export interface UnitRatingsByWindow {
+    allTime: UnitRatingBucket;
+    last6Months: UnitRatingBucket;
+    last3Reviews: UnitRatingBucket;
+}
+export interface UnitRatings {
+    all: UnitRatingsByWindow;
+    airbnb: UnitRatingsByWindow;
+    booking: UnitRatingsByWindow;
+    vrbo: UnitRatingsByWindow;
+}
 export declare const UNIT_TYPES: {
     readonly SINGLE: "single";
     readonly MULTI_PARENT: "multi-listing-parent";
@@ -120,20 +153,8 @@ export interface UnitDocument extends mongoose.Document {
     updatedAt: Date;
     isTrue: boolean;
     rating: number;
-    reviews: {
-        body: string;
-        isPublic: boolean;
-        rating: number;
-        createdAt: Date;
-        reservationId: string;
-        externalId: string;
-        platform: UnitReviewPlatform;
-        guest: GuestDocument;
-        categories: {
-            name: UnitReviewCategory;
-            rating: number;
-        }[];
-    }[];
+    reviews: UnitReview[];
+    ratings: UnitRatings;
     salesBlockWarning: string;
     hasOpenExtensionLink: boolean;
     lengthOfStayType: 'monthly' | 'hybrid' | 'nightly';

package/build/src/models/units.js

@@ -38,6 +38,15 @@ exports.TAX_QUANTIFIERS = {
     PER_STAY: 'PER_STAY',
     PER_NIGHT: 'PER_NIGHT'
 };
+const ratingBucketSchema = new mongoose_1.default.Schema({
+    rating: { type: Number, required: true, default: 0 },
+    count: { type: Number, required: true, default: 0 }
+}, { _id: false });
+const ratingsByWindowSchema = new mongoose_1.default.Schema({
+    allTime: { type: ratingBucketSchema, required: true, default: () => ({}) },
+    last6Months: { type: ratingBucketSchema, required: true, default: () => ({}) },
+    last3Reviews: { type: ratingBucketSchema, required: true, default: () => ({}) }
+}, { _id: false });
 const schema = new mongoose_1.default.Schema({
     name: { type: String, required: true },
     code: { type: Number, required: true },
@@ -163,9 +172,12 @@ const schema = new mongoose_1.default.Schema({
             {
                 body: { type: String, required: true },
                 isPublic: { type: Boolean, required: true },
+                isPublicOnChannel: { type: Boolean, required: false },
                 rating: { type: Number, required: true },
+                nativeRating: { type: Number, required: false },
+                nativeScale: { type: Number, enum: [5, 10], required: false },
                 createdAt: { type: Date, required: true },
-                reservationId: { type: String, required: true },
+                reservationId: { type: String, required: false },
                 externalId: { type: String, required: true },
                 platform: { type: String, required: true },
                 guest: { type: mongoose_1.Schema.Types.ObjectId, ref: 'Guest', required: true },
@@ -184,6 +196,16 @@ const schema = new mongoose_1.default.Schema({
         required: false,
         _id: false
     },
+    ratings: {
+        type: new mongoose_1.default.Schema({
+            all: { type: ratingsByWindowSchema, required: true, default: () => ({}) },
+            airbnb: { type: ratingsByWindowSchema, required: true, default: () => ({}) },
+            booking: { type: ratingsByWindowSchema, required: true, default: () => ({}) },
+            vrbo: { type: ratingsByWindowSchema, required: true, default: () => ({}) }
+        }, { _id: false }),
+        required: false,
+        default: () => ({})
+    },
     salesBlockWarning: { type: String, required: false },
     hasOpenExtensionLink: { type: Boolean, required: false },
     lengthOfStayType: { type: String, required: false },

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vibe-flats/booking-engine-common-server",
-	"version": "1.0.156",
+	"version": "1.0.158",
 	"description": "",
 	"main": "./build/index.js",
 	"types": "./build/index.d.ts",