@foodtolls/common 2.0.1 → 2.2.0

package/src/enums/notification.enum.ts

@@ -0,0 +1,38 @@
+export enum NotificationType {
+  ORDER_PLACED = "ORDER_PLACED",
+  ORDER_ACCEPTED = "ORDER_ACCEPTED",
+  ORDER_PREPARING = "ORDER_PREPARING",
+  ORDER_READY = "ORDER_READY",
+  ORDER_COMPLETED = "ORDER_COMPLETED",
+  ORDER_CANCELLED = "ORDER_CANCELLED",
+  PAYMENT_SUCCESS = "PAYMENT_SUCCESS",
+  PAYMENT_FAILED = "PAYMENT_FAILED",
+  PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
+  VENDOR_APPROVED = "VENDOR_APPROVED",
+  VENDOR_REJECTED = "VENDOR_REJECTED",
+  OTP_REQUEST = "OTP_REQUEST",
+  DELIVERY_ASSIGNED = "DELIVERY_ASSIGNED",
+  DELIVERY_PICKED_UP = "DELIVERY_PICKED_UP",
+  DELIVERY_COMPLETED = "DELIVERY_COMPLETED",
+}
+
+export enum NotificationChannel {
+  PUSH = "PUSH",
+  EMAIL = "EMAIL",
+  SMS = "SMS",
+  ALL = "ALL",
+}
+
+export enum NotificationPriority {
+  LOW = "LOW",
+  NORMAL = "NORMAL",
+  HIGH = "HIGH",
+  URGENT = "URGENT",
+}
+
+export enum NotificationStatus {
+  PENDING = "PENDING",
+  SENT = "SENT",
+  FAILED = "FAILED",
+  IGNORED = "IGNORED",
+}

package/src/index.ts

@@ -2,11 +2,14 @@ export * from "./enums/order.enum";
 export * from "./enums/vendor.enum";
 export * from "./enums/payment.enum";
 export * from "./enums/auth.enum";
+export * from "./enums/notification.enum";
 export * from "./constants/order.constants";
 export * from "./interfaces/order.interface";
 export * from "./interfaces/orderTrack.interface";
 export * from "./interfaces/inventory.interface";
 export * from "./interfaces/gmap.interface";
+export * from "./interfaces/notification.interface";
+export * from "./interfaces/menu.interface";
 export * from "./utils/menu.util";
 export * from "./utils/reachTimeSelection";
 export * from "./saga";

package/src/interfaces/inventory.interface.ts

@@ -1,9 +1,10 @@
+import { MenuCategory, TimeSlotsRange } from "./menu.interface";
 import { IOrderEntity } from "./order.interface";
 
 export interface InventoryRedis {
   restaurantWorkingHours: WorkingHours[];
   menu: [] | MenuCategory[];
-  timeSlots: [] | TimeSlot[];
+  timeSlots: [] | TimeSlotsRange[];
 }
 
 export interface WorkingHours {
@@ -29,90 +30,10 @@ export enum RestaurantOpen {
   CLOSED = "Closed",
 }
 
-export interface Image {
-  uid: number;
-  name: string;
-  status: string;
-  url: string;
-}
-
-export enum TimeSlotType {
-  DEFAULT = "DEFAULT",
-  CUSTOM = "CUSTOM",
-}
-
-export interface AvailableHours {
-  from: string;
-  to: string;
-}
-
-export interface AvailableHoursMap {
-  Monday: string[];
-  Tuesday: string[];
-  Wednesday: string[];
-  Thursday: string[];
-  Friday: string[];
-  Saturday: string[];
-  Sunday: string[];
-}
-
-export interface FoodItem {
-  key: string;
-  subcategory_id: string;
-  food_id: string;
-  label: string;
-  price: number;
-  totalPrice: number;
-  description: string;
-  gstPercentage: number;
-  gst: number;
-  packaging: boolean;
-  packaging_charges: number | null;
-  servings: number;
-  category: string;
-  status: string;
-  images: Image[];
-  availableDays: string[];
-  availableHours: AvailableHoursMap;
-  ratings: {
-    averageRatings: number;
-    ratingCount: number;
-  };
-  type: string;
-  addOns: any[]; // refine later if you have add-on structure
-  healthy: boolean;
-  vegan: boolean;
-  recommend: boolean;
-  cuisine: string[];
-}
-
-export interface SubCategory {
-  key: string;
-  category_id: string;
-  label: string;
-  subcategory_id: string;
-  foodItems: FoodItem[];
-}
-
-export interface MenuCategory {
-  key: string;
-  category_id: string;
-  label: string;
-  hasSubCategory: boolean;
-  children: Array<SubCategory | FoodItem>;
-}
-
-export interface TimeSlot {
-  slotName: string;
-  availableHours: AvailableHours;
-  type: TimeSlotType;
-  crossingOver: boolean;
-}
-
 export interface SetMenuDetailsDetails {
   restaurantId: string;
   menuCard: MenuCategory[];
-  timeSlots: TimeSlot[];
+  timeSlots: TimeSlotsRange[];
 }
 
 export interface InventoryFoodAvailability {

package/src/interfaces/menu.interface.ts

@@ -0,0 +1,213 @@
+//Image
+export interface Image {
+  uid: string;
+  name: string;
+  status: string;
+  url: string;
+}
+
+//Availalility
+export enum TimeSlotType {
+  DEFAULT = "DEFAULT",
+  CUSTOM = "CUSTOM",
+}
+
+export interface AvailableHours {
+  from: string;
+  to: string;
+}
+
+export interface TimeSlotsRange {
+  slotName: string;
+  availableHours: AvailableHours;
+  type: TimeSlotType;
+  crossingOver: boolean;
+}
+
+export interface AvailableHours {
+  Monday: string[];
+  Tuesday: string[];
+  Wednesday: string[];
+  Thursday: string[];
+  Friday: string[];
+  Saturday: string[];
+  Sunday: string[];
+}
+
+//Addons
+export interface AddonItem {
+  addon_id: string;
+  label: string;
+  price: number;
+  gstPercentage: number;
+  isDefault: boolean;
+  sortOrder: number;
+}
+
+export interface AddonGroup {
+  group_id: string;
+  label: string;
+  selectionType: "SINGLE_SELECT" | "MULTI_SELECT";
+  minSelect: number;
+  maxSelect: number;
+  addons: AddonItem[];
+}
+
+//Stock
+export interface Stock {
+  initialStockPerDay: number;
+  currentStock: number;
+  autoRefresh: boolean;
+  nextRefreshAt: string;
+}
+
+//Offers
+export enum OfferScope {
+  ITEM = "ITEM",
+  CATEGORY = "CATEGORY",
+  RESTAURANT = "RESTAURANT",
+}
+
+export enum OfferType {
+  FLAT = "FLAT",
+  PERCENT = "PERCENT",
+  BOGO = "BOGO",
+  BUY_X_GET_Y = "BUY_X_GET_Y",
+  COMBO_DISCOUNT = "COMBO_DISCOUNT",
+}
+
+export interface OfferReward {
+  rewardType: "FLAT" | "PERCENT" | "FREE_ITEM" | "DISCOUNTED_ITEM";
+  flatAmount?: number;
+  percent?: number;
+  freeItemId?: string;
+  discountedPrice?: number;
+}
+
+export interface Offer {
+  offer_id: string;
+  scope: OfferScope;
+  type: OfferType;
+  title: string;
+
+  startAt: string; // ISO timestamp
+  endAt: string;
+
+  priority: number;
+  stackable: boolean;
+
+  rewards: OfferReward[];
+}
+
+//Combos
+export interface ComboFixedItem {
+  item_id: string;
+  quantity: number;
+}
+
+export interface ComboGroupItem {
+  item_id: string;
+  defaultQuantity: number;
+  extraPrice: number;
+}
+
+export interface ComboGroup {
+  group_id: string;
+  label: string;
+  selectionType: "SINGLE_SELECT" | "MULTI_SELECT";
+  minSelect: number;
+  maxSelect: number;
+  items: ComboGroupItem[];
+}
+
+export interface Combo {
+  combo_id: string;
+  label: string;
+  description: string;
+  basePrice: number;
+  discountPrice?: number;
+
+  fixedItems: ComboFixedItem[];
+  groups: ComboGroup[];
+}
+
+//FoodItem
+export interface FoodItem {
+  key: string;
+  food_id: string;
+  subcategory_id: string;
+
+  label: string;
+  price: number;
+  totalPrice: number;
+  description: string;
+
+  gstPercentage: number;
+  gst: number;
+
+  packaging: boolean;
+  packaging_charges: number | null;
+  servings: number;
+
+  category: string; // "fresh" or "packaged"
+  status: string; // "Available" or "Unavailable"
+
+  images: [];
+
+  availableDays: string[];
+  availableHours: AvailableHours;
+
+  ratings: {
+    averageRatings: number;
+    ratingCount: number;
+  };
+
+  type: string; // veg/nonveg/egg
+
+  healthy: boolean;
+  vegan: boolean;
+  recommend: boolean;
+  cuisine: string;
+
+  /** NEW SECTIONS */
+
+  addOns: AddonGroup[];
+
+  stock: Stock;
+
+  offers: Offer[];
+
+  combos: Combo[];
+}
+
+//SubCategory
+export interface SubCategory {
+  key: string;
+  category_id: string;
+  label: string;
+  subcategory_id: string;
+
+  foodItems: FoodItem[];
+}
+
+//Category
+export interface MenuCategory {
+  key: string;
+  category_id: string;
+  label: string;
+  hasSubCategory: boolean;
+
+  children: Array<SubCategory | FoodItem>;
+}
+
+//Full Menu Structure
+export interface SetMenuDetails {
+  restaurantId: string;
+
+  menuCard: MenuCategory[];
+
+  timeSlots: TimeSlotsRange[];
+
+  // Optional global restaurant offers
+  restaurantOffers?: Offer[];
+}

package/src/interfaces/notification.interface.ts

@@ -0,0 +1,22 @@
+import {
+  NotificationType,
+  NotificationPriority,
+} from "../enums/notification.enum";
+
+export interface INotificationPayload {
+  eventType: NotificationType;
+  userId: string;
+  userType: "USER" | "VENDOR" | "ADMIN";
+  recipientEmail?: string;
+  recipientPhone?: string;
+  data: Record<string, any>;
+  priority: NotificationPriority;
+  metadata?: any;
+}
+
+export interface IDeliveryAttempt {
+  attemptNumber: number;
+  timestamp: Date;
+  status: string;
+  errorMessage?: string;
+}

package/src/saga/redis-ack-tracker.ts

@@ -36,10 +36,10 @@ export class RedisAckTracker {
       // Check each pending acknowledgment
       for (const ackKey of Array.from(pendingAcks)) {
         const ackData = await this.getAck(sagaId, ackKey);
-        
+
         if (ackData) {
           pendingAcks.delete(ackKey);
-          
+
           if (!ackData.success) {
             // Service reported failure
             failedAcks.push(ackKey);
@@ -73,7 +73,9 @@ export class RedisAckTracker {
     return {
       success: false,
       sagaId,
-      error: `Timeout waiting for acknowledgments: ${Array.from(pendingAcks).join(", ")}`,
+      error: `Timeout waiting for acknowledgments: ${Array.from(
+        pendingAcks
+      ).join(", ")}`,
       failedAcks: Array.from(pendingAcks),
       timedOut: true,
     };
@@ -117,7 +119,7 @@ export class RedisAckTracker {
   async getAck(sagaId: string, ackKey: string): Promise<AckData | null> {
     const key = this.getAckKey(sagaId, ackKey);
     const data = await this.redis.get(key);
-    
+
     if (!data) {
       return null;
     }
@@ -137,12 +139,7 @@ export class RedisAckTracker {
    */
   async setSagaState(sagaId: string, state: SagaState): Promise<void> {
     const key = `saga:${sagaId}:state`;
-    await this.redis.set(
-      key,
-      state,
-      "EX",
-      this.ACK_TTL_SECONDS
-    );
+    await this.redis.set(key, state, "EX", this.ACK_TTL_SECONDS);
   }
 
   /**

package/src/utils/menu.util.ts

@@ -1,4 +1,9 @@
-import { MenuCategory,TimeSlotType,SubCategory,FoodItem } from "../interfaces/inventory.interface";
+import {
+  MenuCategory,
+  TimeSlotType,
+  SubCategory,
+  FoodItem,
+} from "../interfaces/menu.interface";
 
 export const findReqCategory = (Menu: MenuCategory[], category: string) => {
   // console.log("findReqCategory", Menu, category);

package/tsconfig.json

@@ -16,6 +16,7 @@
     "noImplicitAny": false,
     "strictBindCallApply": false,
     "forceConsistentCasingInFileNames": false,
-    "noFallthroughCasesInSwitch": false
+    "noFallthroughCasesInSwitch": false,
+    "esModuleInterop": true
   }
 }