@foodtolls/common 2.5.1 → 2.6.1

package/src/kafka-topics/all-topics.ts

@@ -0,0 +1,497 @@
+import { CancelledType, OrderStatus, OrderType } from "src/enums/order.enum";
+import { PAYMENTSTATUS, REFUNDSTATUS } from "src/enums/payment.enum";
+import { DistanceTimeToReach } from "src/interfaces/gmap.interface";
+import { OrderTrackDTO } from "src/interfaces/orderTrack.interface";
+
+/**
+ * Kafka Topic: Create.Order.Payment
+ * Producer: order-management-service
+ * Consumers: payment-service, user-service, notification-service
+ *
+ * Triggered when a new order is created and payment needs to be initiated
+ */
+export interface CreateOrderPaymentEvent {
+  orderId: string;
+  orderDetails: {
+    foodItem: Array<{
+      count: number;
+      name: string;
+    }>;
+    orderType: string;
+    serviceType: string;
+    gstCharges: number;
+    packagingCharges: number;
+    platformFee: number;
+    orderFinalPrice: number;
+  };
+  restaurantId: string;
+  userId: string;
+  amount: number;
+  currency: string;
+}
+
+/**
+ * Kafka Topic: New.Order.Topic
+ * Producer: order-management-service
+ * Consumers: vendor-service, admin-service
+ *
+ * Triggered when order payment is successful and vendor needs to be notified
+ */
+export interface NewOrderEvent {
+  orderId: string;
+  userId: string;
+  restaurantId: string;
+  totalAmount: number;
+  gst: number;
+  paymentStatus: PAYMENTSTATUS;
+  orderStatus: OrderStatus;
+  orderType: OrderType;
+  orderDateTime: Date;
+  orderReachTime: number;
+  serviceType: string;
+  orderItems: Array<{
+    foodId: string;
+    quantity: number;
+    categoryId: string;
+    subCategoryId?: string;
+    price: number;
+    gstAmount: number;
+    packagingCharges: number;
+  }>;
+}
+
+/**
+ * Kafka Topic: Order.PaymentStatus.Topic
+ * Producer: payment-service
+ * Consumers: order-management-service, user-service
+ *
+ * Triggered when payment status changes (success/failure)
+ */
+export interface OrderPaymentStatusEvent {
+  orderId: string;
+  razorOrderId?: string;
+  orderStatus: OrderStatus;
+  paymentStatus: PAYMENTSTATUS;
+}
+
+/**
+ * Kafka Topic: Vendor.Create.Topic
+ * Producer: user-authentication-service
+ * Consumers: vendor-service
+ *
+ * Triggered when a new vendor is created in the system
+ */
+export interface VendorCreateEvent {
+  mobileNumber: number;
+  vendorId: string;
+  // Generic payload - needs more analysis
+}
+
+/**
+ * Kafka Topic: Check.Food.Availability
+ * Producer: order-management-service
+ * Consumers: vendor-service
+ *
+ * Check if food items are available at a restaurant before order creation
+ */
+export interface CheckFoodAvailabilityEvent {
+  redisId: string;
+  restaurantId: string;
+  src: {
+    latitude: number;
+    longitude: number;
+  };
+  foodItems: Array<{
+    foodId: string;
+    categoryId: string;
+    subCategoryId?: string;
+    status: "Available" | "Not Available";
+  }>;
+  orderCreateDate: Date;
+}
+
+/**
+ * Kafka Topic: Order.Inventory.Load
+ * Producer: order-management-service
+ * Consumers: vendor-service
+ *
+ * Load order into vendor's inventory system
+ */
+export interface OrderInventoryLoadEvent {
+  Restaurant: string;
+  Order: string;
+  orderStatus: OrderStatus;
+  userId: string;
+}
+
+/**
+ * Kafka Topic: Order.Status.Ack.Update
+ * Producer: order-management-service
+ * Consumers: vendor-service
+ *
+ * Acknowledge order status update
+ */
+export interface OrderStatusAckUpdateEvent {
+  orderId: string;
+  orderStatus: OrderStatus;
+}
+
+/**
+ * Kafka Topic: Update.Order.CancelledStatus
+ * Producer: order-management-service, order-handler-service
+ * Consumers: vendor-service, user-service, order-management-service
+ *
+ * Triggered when an order is cancelled
+ */
+export interface UpdateOrderCancelledStatusEvent {
+  orderId: string;
+  cancelledType: CancelledType;
+  cancelledReason: string;
+}
+
+/**
+ * Kafka Topic: Track.Update.Order.Cancelled
+ * Producer: order-management-service, order-handler-service
+ * Consumers: vendor-service, user-service, order-management-service
+ *
+ * Triggered when an order is cancelled
+ */
+export interface TrackUpdateOrderCancelledEvent {
+  userId: string;
+  orderId: string;
+  cancelledType: CancelledType;
+  cancelledReason: string;
+}
+
+/**
+ * Kafka Topic: Order.Item.Partial.Update
+ * Producer: order-management-service
+ * Consumers: vendor-service, user-service
+ *
+ * Triggered when some items in an order are not available
+ */
+export interface OrderItemPartialUpdateEvent {
+  orderId: string;
+  refundId: string;
+  paymentId: string;
+  orderDetails: {
+    orderId: string;
+    orderStatus: OrderStatus;
+    foodItems: Array<{
+      foodId: string;
+      categoryId: string;
+      subCategoryId?: string;
+      status: string;
+    }>;
+  };
+}
+
+/**
+ * Kafka Topic: Initiate.Order.Refund
+ * Producer: order-management-service, order-handler-service
+ * Consumers: payment-service
+ *
+ * Initiate a full refund for an order
+ */
+export interface InitiateOrderRefundEvent {
+  orderId: string;
+  refundedBy?: string;
+}
+
+/**
+ * Kafka Topic: Initiate.Partial.Order.Refund
+ * Producer: order-management-service, order-handler-service
+ * Consumers: payment-service
+ *
+ * Initiate a partial refund for an order
+ */
+export interface InitiatePartialOrderRefundEvent {
+  orderId: string;
+  orderDetails: {
+    orderId: string;
+    orderStatus: OrderStatus;
+    foodItems: Array<{
+      foodId: string;
+      categoryId: string;
+      subCategoryId?: string;
+      status: string;
+    }>;
+  };
+  reason: string;
+}
+
+/**
+ * Kafka Topic: Check.Refund.Status
+ * Producer: order-handler-service
+ * Consumers: payment-service
+ *
+ * Check status of a refund
+ */
+export interface CheckRefundStatusEvent {
+  orderId: string;
+  paymentId: string;
+  refundId: string;
+}
+
+/**
+ * Kafka Topic: Order.RefundStatus.Topic
+ * Producer: payment-service
+ * Consumers: order-management-service, user-service
+ *
+ * Update on refund status
+ */
+export interface OrderRefundStatusEvent {
+  orderId: string;
+  orderStatus: OrderStatus;
+  paymentStatus: PAYMENTSTATUS;
+  refundStatus: REFUNDSTATUS;
+  refundAmount: number;
+  cancelledReason: string;
+  cancelledType: CancelledType;
+  refundId: string;
+  paymentId: string;
+}
+
+/**
+ * Kafka Topic: Order.PartialRefundStatus.Topic
+ * Producer: payment-service
+ * Consumers: order-management-service
+ *
+ * Update on partial refund status
+ */
+export interface OrderPartialRefundStatusEvent {
+  orderId: string;
+  refundId: string;
+  paymentId: string;
+  orderStatus: OrderStatus;
+  paymentStatus: PAYMENTSTATUS;
+  refundStatus: REFUNDSTATUS;
+  refundAmount: number;
+}
+
+/**
+ * Kafka Topic: Order.Status.Topic
+ * Producer: vendor-service
+ * Consumers: order-management-service, user-service
+ *
+ * Vendor updates order status (preparing, ready, etc.)
+ */
+export interface OrderStatusEvent {
+  orderId: string;
+  status: OrderStatus;
+}
+
+/**
+ * Kafka Topic: Order.RejectStatus.Topic
+ * Producer: vendor-service
+ * Consumers: order-management-service, user-service
+ *
+ * Vendor rejects an order
+ */
+export interface OrderRejectStatusEvent {
+  orderId: string;
+  cancelledType: CancelledType;
+  cancelledReason: string;
+}
+
+/**
+ * Kafka Topic: Request.Order.Track.Order
+ * Producer: vendor-service
+ * Consumers: order-management-service
+ *
+ * Request order tracking information
+ */
+export interface RequestOrderTrackOrderEvent {
+  userId: string;
+  orderId: string;
+  trackPayload: {
+    src: {
+      lat: number | undefined;
+      lng: number | undefined;
+    };
+    dest: {
+      lat: number | undefined;
+      lng: number | undefined;
+    };
+    firstUpdate: Date;
+    currentUpdates: Date | undefined;
+    distanceTimeToReach: DistanceTimeToReach | undefined;
+    orderStatus: OrderStatus;
+    orderCreateDate: Date;
+  };
+}
+
+/**
+ * Kafka Topic: Order.Payment.Failed
+ * Producer: payment-service
+ * Consumers: order-management-service, user-service
+ *
+ * Payment for an order failed
+ */
+export interface OrderPaymentFailedEvent {
+  orderId: string;
+  orderStatus: OrderStatus;
+  paymentStatus: PAYMENTSTATUS;
+  paymentId: string;
+  razorOrderId: string;
+  cancelledReason: string;
+  cancelledType: CancelledType;
+}
+
+/**
+ * Kafka Topic: Notification.Event
+ * Producer: multiple services
+ * Consumers: notification-service
+ *
+ * Generic notification event
+ */
+export interface NotificationEvent {
+  userId: string;
+  orderId: string;
+  type: "payment_timeout" | "payment_late_success" | "payment_failed" | string;
+  message: string;
+  amount?: number;
+  timestamp: number;
+}
+
+/**
+ * Kafka Topic: Refund.Update.Status
+ * Producer: payment-service
+ * Consumers: order-handler-service
+ *
+ * Update on refund processing status
+ */
+export interface RefundUpdateStatusEvent {
+  orderId: string;
+  refundStatus: REFUNDSTATUS.REFUNDCOMPLETED;
+}
+
+/**
+ * Kafka Topic: User.Create.Topic
+ * Producer: user-authentication-service
+ * Consumers: user-service
+ *
+ * New user created in the system
+ */
+export interface UserCreateEvent {
+  mobileNumber: number;
+  userId: string;
+}
+
+/**
+ * Kafka Topic: Vendor.RegStatus.Topic
+ * Producer: unknown
+ * Consumers: user-authentication-service
+ *
+ * Vendor registration status update
+ */
+export interface VendorRegStatusEvent {
+  vendorId: string;
+  status: string;
+  // Additional fields need analysis from producer
+}
+
+/**
+ * Kafka Topic: Order.LongTrack.Cancel
+ * Producer: unknown
+ * Consumers: user-service
+ *
+ * Cancel long tracking for an order
+ */
+export interface OrderLongTrackCancelEvent {
+  orderId: string;
+  orderStatus: OrderStatus;
+  reason: string;
+}
+
+/**
+ * Kafka Topic: Track.Update.Order.ONLAZYTRACK
+ * Producer: unknown
+ * Consumers: vendor-service, user-service
+ *
+ * Update order tracking status (lazy tracking mode)
+ */
+export interface TrackUpdateOrderOnLazyTrackEvent {
+  userId: string;
+  orderId: string;
+  trackPayload: OrderTrackDTO;
+}
+
+/**
+ * Kafka Topic: Track.Update.Order.Preparing
+ * Producer: unknown
+ * Consumers: vendor-service
+ *
+ * Update order tracking when status is preparing
+ */
+export interface TrackUpdateOrderPreparingEvent {
+  userId: string;
+  orderId: string;
+  trackPayload: OrderTrackDTO;
+}
+
+/**
+ * Kafka Topic: Check.Cart.Food.Availability
+ * Producer: unknown
+ * Consumers: vendor-service
+ *
+ * Check food availability for cart items
+ */
+export interface CheckCartFoodAvailabilityEvent {
+  restaurantId: string;
+  foodItems: Array<{
+    foodId: string;
+    categoryId: string;
+    subCategoryId?: string;
+  }>;
+  userId: string;
+}
+
+/**
+ * Kafka Topic: Hotel.Inventory.Load
+ * Producer: unknown
+ * Consumers: vendor-service
+ *
+ * Load hotel/restaurant inventory
+ */
+export interface HotelInventoryLoadEvent {
+  restaurantIds: string[];
+}
+
+/**
+ * Kafka Topic: Request.Order.Track.Vendor
+ * Producer: unknown
+ * Consumers: vendor-service
+ *
+ * Vendor-specific order tracking request
+ */
+export interface RequestOrderTrackVendorEvent {
+  orderId: string;
+  restaurantId: string;
+  trackType: string;
+}
+
+/**
+ * Kafka Topic: Order.Queue.Add.Monitor
+ * Producer: unknown
+ * Consumers: order-management-service
+ *
+ * Add order to monitoring queue
+ */
+export interface OrderQueueAddMonitorEvent {
+  orderId: string;
+  queueType: "ready" | "serving";
+  statusChangeDate: Date;
+}
+
+/**
+ * Kafka Topic: Vendor.Create.Rollback.Topic
+ * Producer: unknown
+ * Consumers: vendor-service
+ *
+ * Rollback vendor creation (saga pattern)
+ */
+export interface VendorCreateRollbackEvent {
+  vendorId: string;
+  reason: string;
+}