picker-db 3.4.0

package/modules/picker/schemas/bookings.js

@@ -0,0 +1,699 @@
+const { VEHICLE_TYPES, PAYMENT_METHODS, BOOKING_TYPES, BOOKING_STATUS } = require("../../../constants");
+const { DEVICE_TYPES } = require("../../../constants").USER;
+
+const PricingDetailsSchema = require("./pricingDetails");
+const ProductSchema = require("./bookingProduct");
+const { getModel } = require("../models/identityCounter");
+
+const ALLOWED_STATUSES = [
+  BOOKING_STATUS.PENDING.INDEX,
+  BOOKING_STATUS.ACCEPTED.INDEX,
+  BOOKING_STATUS.ARRIVED_AT_PICKUP.INDEX,
+  BOOKING_STATUS.WAY_TO_DELIVER.INDEX,
+  BOOKING_STATUS.ARRIVED_AT_DELIVERY.INDEX,
+  BOOKING_STATUS.COMPLETED.INDEX,
+  BOOKING_STATUS.CANCELLED_BY_ADMIN.INDEX,
+  BOOKING_STATUS.CANCELLED.INDEX,
+  BOOKING_STATUS.CANCELLED_BY_DRIVER.INDEX,
+  BOOKING_STATUS.REJECTED_BY_DRIVER.INDEX,
+  BOOKING_STATUS.CANCELLED_REQUEST.INDEX,
+  BOOKING_STATUS.NOT_FOUND.INDEX,
+  BOOKING_STATUS.NOT_DELIVERED.INDEX,
+  BOOKING_STATUS.ON_DECK.INDEX,
+  BOOKING_STATUS.READY_FOR_PICKUP.INDEX,
+  BOOKING_STATUS.CANCELLED_BY_BUSINESS.INDEX,
+  BOOKING_STATUS.REJECTED_BY_BUSINESS.INDEX,
+  BOOKING_STATUS.PAYMENT_FAILED.INDEX,
+  BOOKING_STATUS.CANCELLED_BY_DELIVERY_PROVIDER.INDEX,
+  BOOKING_STATUS.PROVIDER_NOT_FOUND.INDEX,
+  BOOKING_STATUS.RETURNING.INDEX,
+  BOOKING_STATUS.RETURNED.INDEX,
+  BOOKING_STATUS.RETURNED_TO_PICKUP.INDEX,
+];
+
+const ALLOWED_STATUS_TEXTS = [
+  BOOKING_STATUS.PENDING.TEXT,
+  BOOKING_STATUS.ACCEPTED.TEXT,
+  BOOKING_STATUS.ARRIVED_AT_PICKUP.TEXT,
+  BOOKING_STATUS.WAY_TO_DELIVER.TEXT,
+  BOOKING_STATUS.ARRIVED_AT_DELIVERY.TEXT,
+  BOOKING_STATUS.COMPLETED.TEXT,
+  BOOKING_STATUS.CANCELLED_BY_ADMIN.TEXT,
+  BOOKING_STATUS.CANCELLED.TEXT,
+  BOOKING_STATUS.CANCELLED_BY_DRIVER.TEXT,
+  BOOKING_STATUS.REJECTED_BY_DRIVER.TEXT,
+  BOOKING_STATUS.CANCELLED_REQUEST.TEXT,
+  BOOKING_STATUS.NOT_FOUND.TEXT,
+  BOOKING_STATUS.NOT_DELIVERED.TEXT,
+  BOOKING_STATUS.ON_DECK.TEXT,
+  BOOKING_STATUS.READY_FOR_PICKUP.TEXT,
+  BOOKING_STATUS.CANCELLED_BY_BUSINESS.TEXT,
+  BOOKING_STATUS.REJECTED_BY_BUSINESS.TEXT,
+  BOOKING_STATUS.PAYMENT_FAILED.TEXT,
+  BOOKING_STATUS.CANCELLED_BY_DELIVERY_PROVIDER.TEXT,
+  BOOKING_STATUS.PROVIDER_NOT_FOUND.TEXT,
+  BOOKING_STATUS.RETURNING.TEXT,
+  BOOKING_STATUS.RETURNED.TEXT,
+  BOOKING_STATUS.RETURNED_TO_PICKUP.TEXT,
+];
+
+/** @param {import("mongoose")} connection */
+module.exports = (connection) => {
+  const IdentityCounterModel = getModel(connection);
+  // #region Internal Schemas
+  const orderLogs = new connection.base.Schema({
+    orderAmount: { type: Number },
+    status: {
+      type: Number,
+      required: true,
+      enum: [
+        BOOKING_STATUS.AMOUNT_REQUESTED.INDEX,
+        BOOKING_STATUS.AMOUNT_ACCEPTED.INDEX,
+        BOOKING_STATUS.AMOUNT_REJECTED.INDEX,
+      ],
+    },
+    statusText: {
+      type: String,
+      required: true,
+      enum: [
+        BOOKING_STATUS.AMOUNT_REQUESTED.TEXT,
+        BOOKING_STATUS.AMOUNT_ACCEPTED.TEXT,
+        BOOKING_STATUS.AMOUNT_REJECTED.TEXT,
+      ],
+    },
+    timeStamp: { type: Date, required: true },
+    paymentMethod: {
+      type: String,
+      required: true,
+      enum: [
+        PAYMENT_METHODS.CARD.TEXT,
+        PAYMENT_METHODS.CASH.TEXT,
+      ],
+    },
+  });
+
+  const bookingLogs = new connection.base.Schema({
+    timeStamp: {
+      type: Date,
+      required: true,
+    },
+    previousStatus: {
+      type: Number,
+      required: true,
+      enum: ALLOWED_STATUSES,
+    },
+    previousStatusText: {
+      type: String,
+      required: true,
+      enum: ALLOWED_STATUS_TEXTS,
+    },
+    newStatus: {
+      type: Number,
+      required: true,
+      enum: ALLOWED_STATUSES,
+    },
+    newStatusText: {
+      type: String,
+      required: true,
+      enum: ALLOWED_STATUS_TEXTS,
+    },
+  }, { _id: false });
+  // #endregion Internal Schemas
+
+  const BookingSchema = new connection.base.Schema({
+    bookingNumericId: {
+      type: Number,
+      index: true,
+    },
+    // #region Business Info
+    business: {
+      type: connection.base.Schema.ObjectId,
+      ref: "User",
+    },
+    businessName: {
+      type: String,
+    },
+    businessImage: {
+      thumbnail: { type: String, default: null },
+      original: { type: String, default: null },
+    },
+    businessMobile: {
+      type: String,
+      default: null,
+    },
+    businessTag: {
+      type: String,
+      default: null,
+    },
+    businessUniqueID: {
+      type: String,
+    },
+    // #endregion Business Info
+    // #region WS info
+    workspaceID: {
+      type: connection.base.Schema.ObjectId,
+      default: null,
+      index: true,
+      sparse: true,
+    },
+    workspaceName: {
+      type: String,
+    },
+    // #endregion
+    // #region Customer Info
+    customer: {
+      type: connection.base.Schema.ObjectId,
+      ref: "User",
+      required: true,
+    },
+    customerName: {
+      type: String,
+      index: true,
+      required: true,
+    },
+    customerMobile: {
+      type: String,
+      required: true,
+      trim: true,
+      index: true,
+    },
+    customerImage: {
+      thumbnail: { type: String, default: null },
+      original: { type: String, default: null },
+    },
+    customerEmail: {
+      type: String,
+      default: null,
+    },
+    completedCustomerBookings: {
+      type: Number,
+    },
+    oneSignalId: {
+      type: String,
+    },
+    realPhone: {
+      type: String,
+    },
+    realPosition: {
+      type: {
+        type: String,
+        default: "Point",
+      },
+      coordinates: [Number],
+    },
+    customerDeviceType: {
+      type: String,
+      enum: [
+        DEVICE_TYPES.IOS,
+        DEVICE_TYPES.ANDROID,
+        DEVICE_TYPES.WEB,
+        null,
+      ],
+    },
+    // #endregion Customer Info
+    // #region Driver Info
+    driver: {
+      type: connection.base.Schema.ObjectId,
+      ref: "User",
+      default: null,
+    },
+    driverName: {
+      type: String,
+      index: true,
+      sparse: true,
+      default: null,
+    },
+    driverMobile: {
+      type: String,
+      index: true,
+      sparse: true,
+      default: null,
+    },
+    driverImage: {
+      thumbnail: { type: String, default: null },
+      original: { type: String, default: null },
+    },
+    driverEmail: {
+      type: String,
+      default: null,
+    },
+    driverTag: {
+      type: String,
+      default: null,
+    },
+    driverLocationOnAccept: {
+      type: { type: String, default: "Point" },
+      coordinates: [Number],
+    },
+    customerSegment: {
+      type: String,
+      default: null,
+    },
+    driverAccountingType: { type: String },
+    // #endregion Driver Info
+    // #region Delivery location Info
+    deliveryCity: {
+      type: String,
+      default: null,
+    },
+    deliveryState: {
+      type: String,
+      default: null,
+    },
+    deliveryZipCode: {
+      type: String,
+      default: null,
+    },
+    deliveryAddress: {
+      type: String,
+      default: null,
+    },
+    deliveryCoordinates: {
+      type: { type: String, default: "Point" },
+      coordinates: [Number],
+    },
+    deliveryReferences: {
+      type: String,
+    },
+    // #endregion Delivery location Info
+    // #region Pickup location Info
+    pickupCity: {
+      type: String,
+      default: null,
+    },
+    pickupState: {
+      type: String,
+      default: null,
+    },
+    pickupZipCode: {
+      type: String,
+      default: null,
+    },
+    pickupAddress: {
+      type: String,
+      default: "",
+    },
+    pickupCoordinates: {
+      type: { type: String, default: "Point" },
+      coordinates: [Number],
+    },
+    pickupReferences: {
+      type: String,
+    },
+    // #endregion Pickup location Info
+    pickupDateTimeFrom: { type: Date },
+    pickupDateTimeTo: { type: Date },
+    bookingCompletionDateTime: { type: Date },
+    // #region Vehicle Info
+    vehicleNumber: { type: String },
+    vehicleModelName: { type: String },
+    vehicleColor: {
+      type: String,
+      default: null,
+    },
+    vehicleYear: { type: Number },
+    carType: {
+      type: Number,
+      enum: [
+        VEHICLE_TYPES.LITE.INDEX,
+        VEHICLE_TYPES.BIKE.INDEX,
+      ],
+      index: true,
+    },
+    carName: {
+      type: String,
+      enum: [
+        VEHICLE_TYPES.LITE.TEXT,
+        VEHICLE_TYPES.BIKE.TEXT,
+      ],
+    },
+    // #endregion Vehicle Info
+    // #region Payment Info
+    paymentMethod: {
+      type: String,
+      required: true,
+      enum: [
+        PAYMENT_METHODS.CARD.TEXT,
+        PAYMENT_METHODS.CASH.TEXT,
+        PAYMENT_METHODS.BILLING_CARD.TEXT,
+        PAYMENT_METHODS.BILLING_TRANSFER.TEXT,
+      ],
+    },
+    paymentMethodCode: {
+      type: Number,
+      required: false,
+      enum: [
+        PAYMENT_METHODS.CARD.INDEX,
+        PAYMENT_METHODS.CASH.INDEX,
+        PAYMENT_METHODS.BILLING_CARD.INDEX,
+        PAYMENT_METHODS.BILLING_TRANSFER.INDEX,
+      ],
+    },
+    transactionDetails: {
+      itemCharge: {
+        type: connection.base.Schema.ObjectId,
+        ref: "PaymentezTransaction",
+        default: null,
+      },
+      deliveryCharge: {
+        type: connection.base.Schema.ObjectId,
+        ref: "PaymentezTransaction",
+        default: null,
+      },
+      cancellationCharge: {
+        type: connection.base.Schema.ObjectId,
+        ref: "PaymentezTransaction",
+        default: null,
+      },
+      donationCharge: {
+        type: connection.base.Schema.ObjectId,
+        ref: "PaymentezTransaction",
+        default: null,
+      },
+      tipCharge: {
+        type: connection.base.Schema.ObjectId,
+        ref: "PaymentezTransaction",
+        default: null,
+      },
+    },
+    corporateID: { type: String, index: true },
+    corporateChargeStatus: {
+      type: String,
+      default: "PENDING",
+    },
+    refunds: [
+      {
+        amount: { type: Number, min: 0 },
+        user: { type: connection.base.Schema.ObjectId, ref: "User" },
+        date: { type: Date },
+        type: { type: String },
+      },
+    ],
+    // #endregion Payment Info
+    bookingType: {
+      type: Number,
+      enum: [
+        BOOKING_TYPES.PICKUP_AND_DELIVER.INDEX,
+        BOOKING_TYPES.BUY_AND_DELIVER.INDEX,
+        BOOKING_TYPES.MARKETPLACE.INDEX,
+        BOOKING_TYPES.SHOP_ORDER.INDEX,
+        BOOKING_TYPES.CORPORATE.INDEX,
+        BOOKING_TYPES.WHITE_LABEL.INDEX,
+        BOOKING_TYPES.MASS_DELIVERY.INDEX,
+      ],
+      index: true,
+    },
+    typeText: {
+      type: String,
+      enum: [
+        BOOKING_TYPES.PICKUP_AND_DELIVER.TEXT,
+        BOOKING_TYPES.BUY_AND_DELIVER.TEXT,
+        BOOKING_TYPES.MARKETPLACE.TEXT,
+        BOOKING_TYPES.SHOP_ORDER.TEXT,
+        BOOKING_TYPES.CORPORATE.TEXT,
+        BOOKING_TYPES.WHITE_LABEL.TEXT,
+        BOOKING_TYPES.MASS_DELIVERY.TEXT,
+      ],
+    },
+    bookingDate: {
+      type: Date,
+      default: Date.now,
+    },
+    bookingNotes: {
+      type: String,
+      default: null,
+    },
+    currentStatus: {
+      type: Number,
+      index: true,
+      default: BOOKING_STATUS.PENDING.INDEX,
+    },
+    statusText: {
+      type: String,
+      default: BOOKING_STATUS.PENDING.TEXT,
+    },
+    statusUpdates: { type: [bookingLogs] },
+    deliveryProvider: {
+      type: String,
+    },
+    trackingLink: {
+      type: String,
+    },
+    isLaterBooking: {
+      type: Boolean,
+      default: false,
+    },
+    isRated: {
+      type: Boolean,
+      default: false,
+    },
+    promoApplied: {
+      type: connection.base.Schema.ObjectId,
+      ref: "Promo",
+    },
+    smrToken: {
+      type: String,
+      index: true,
+      sparse: true,
+      unique: true,
+    },
+    isArrivingSoon: {
+      type: Boolean,
+      default: false,
+    },
+    isPossibleFraud: {
+      type: Boolean,
+    },
+    sendInvoice: {
+      type: Boolean,
+      default: true,
+    },
+    chatType: {
+      type: String,
+      default: "OLD",
+    },
+    massDeliveryID: {
+      type: connection.base.Schema.ObjectId,
+      ref: "MassDelivery",
+      index: true,
+      sparse: true,
+      default: null,
+    },
+    // #region Pricing Info
+    priceBreakUp: {
+      notificationCharge: { type: Number, default: 0 },
+      baseFare: { type: Number, default: 0 },
+      perKmCharge: { type: Number, default: 0 },
+      perMinCharge: { type: Number, default: 0 },
+      orderAmount: { type: Number, default: 0 },
+      driverPayment: { type: Number, default: 0 },
+      companyPayment: { type: Number, default: 0 },
+      businessPayment: { type: Number, default: 0 },
+      extraPayment: { type: Number, default: 0 },
+      receivedByDriver: { type: Number, default: 0 },
+      receivedByBusiness: { type: Number, default: 0 },
+      promoDiscount: { type: Number, default: 0 },
+      referralDiscount: { type: Number, default: 0 },
+      comission: { type: Number, default: 0 },
+      donation: { type: Number, default: 0 },
+      tip: { type: Number, default: 0 },
+      taxCharges: { type: Number, default: 0, min: 0 },
+      workBalance: { type: Number, default: 0 },
+      shopOrderRecharge: { type: Number, default: 0 },
+      driverExtraCommission: { type: Number, default: 0 },
+      companyPaymentBusiness: { type: Number, default: 0 },
+      companyPaymentDriver: { type: Number, default: 0 },
+      providerFee: { type: Number, min: 0 },
+      providerFeeNoMarkup: { type: Number, min: 0 },
+    },
+    pendingAmount: {
+      type: Number,
+      default: 0,
+    },
+    deliveryFee: {
+      type: Number,
+      default: 0,
+    },
+    orderAmount: {
+      type: Number,
+      default: 0,
+    },
+    ServiceAmount: {
+      type: Number,
+      default: 0,
+    },
+    totalPay: {
+      type: Number,
+      default: 0,
+    },
+    totalAmount: {
+      type: Number,
+      default: 0,
+    },
+    pricingDetails: PricingDetailsSchema(connection),
+    // #endregion Pricing Info
+    // #region Distance Info
+    distanceTravelled: {
+      type: Number,
+      default: 0,
+    },
+    distanceBreakUp: {
+      realDistance: {
+        type: Number,
+        default: 0,
+      },
+      billedDistance: {
+        type: Number,
+        default: 0,
+      },
+      baseDistance: {
+        type: Number,
+        default: 0,
+      },
+      extraDistance: {
+        type: Number,
+        default: 0,
+      },
+    },
+    regionID: {
+      type: connection.base.Schema.ObjectId,
+      ref: "Region",
+      default: null,
+      index: true,
+      sparse: true,
+    },
+    superRegionID: {
+      type: connection.base.Schema.ObjectId,
+      ref: "SuperRegion",
+      default: null,
+      index: true,
+      sparse: true,
+    },
+    // #endregion Distance Info
+    // #region Time info
+    isTimeStarted: {
+      type: Boolean,
+      default: false,
+    },
+    lastTimeCalculation: { type: Date },
+    totalTime: {
+      type: Number,
+      default: 0,
+    },
+    // #endregion Time info
+    // #region Cancellation Info
+    cancelReasonByDriver: { type: String },
+    cancelReasonByCustomer: { type: String },
+    cancelReasonByServiceProvider: { type: String },
+    cancellationDate: { type: Date },
+    maximumCancellationDate: {
+      default: new Date(),
+      type: Date,
+    },
+    // #endregion Cancellation Info
+    // #region Order Info
+    products: [ProductSchema(connection)],
+    productReferencesImages: [{
+      thumbnail: { type: String, default: null },
+      original: { type: String, default: null },
+    }],
+    orderUpdates: {
+      type: [orderLogs],
+      select: true,
+    },
+    moneyRequested: {
+      type: Boolean,
+      default: false,
+    },
+    moneyAccepted: {
+      type: Boolean,
+      default: false,
+    },
+    orderReceived: {
+      type: Boolean,
+      default: false,
+    },
+    requestedAmount: {
+      type: Number,
+      default: 0,
+    },
+    recentlyRequestedAmount: {
+      type: Number,
+      default: 0,
+    },
+    bidTotal: {
+      type: Number,
+      default: 0,
+    },
+    bidAccepted: {
+      type: Boolean,
+      default: false,
+    },
+    bidProcessing: {
+      type: Boolean,
+      default: false,
+    },
+    bidResponded: {
+      type: Boolean,
+      default: false,
+    },
+    minimumDriverCash: {
+      type: Number,
+      default: 0,
+      min: 0,
+    },
+    // #endregion Order Info
+    reassignationWarningSent: {
+      type: Boolean,
+    },
+    externalOrderId: {
+      type: String,
+    },
+    estimatedTimeToPointA: {
+      type: Number,
+      required: false,
+    },
+    estimatedTimeToPointB: {
+      type: Number,
+      required: false,
+    },
+    origin: {
+      type: String,
+    },
+    fromExternalCredentials: {
+      type: Boolean,
+      default: false,
+    },
+    proofOfDelivery: {
+      type: String,
+    },
+    smrSentVia: [String],
+    cookTime: {
+      type: Number,
+      min: 0,
+    }, // In milliseconds
+    isActive: {
+      type: Boolean,
+      default: true,
+    },
+  }, { timestamps: true });
+
+  BookingSchema.pre("save", function (next) {
+    if (!this.isNew) {
+      return next();
+    }
+    const doc = this;
+    const query = { model: "Bookings" };
+    const update = { $inc: { count: 1 } };
+    const options = { new: true };
+    IdentityCounterModel.findOneAndUpdate(query, update, options, function (error, counter) {
+      if (error) {
+        return next(error);
+      }
+      doc.bookingNumericId = counter.count;
+      next();
+    });
+  });
+
+  return BookingSchema;
+};