@foodtolls/common 2.1.0 → 2.2.1

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,240 @@
+//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[];
+}
+
+//menu diff interfaces
+
+export interface UpdatedField<T> {
+  old: T;
+  new: T;
+}
+
+export interface UpdatedEntity<T> {
+  id: string;
+  changes: Partial<Record<keyof T, UpdatedField<any>>>;
+}
+
+export interface SimpleEntityDiff<T> {
+  added: T[];
+  removed: T[];
+  updated: UpdatedEntity<T>[];
+}
+
+export interface MenuDiff {
+  categories: SimpleEntityDiff<MenuCategory>;
+  subcategories: SimpleEntityDiff<SubCategory>;
+  items: SimpleEntityDiff<FoodItem>;
+  addons: SimpleEntityDiff<AddonGroup>;
+  combos: SimpleEntityDiff<Combo>;
+  offers: SimpleEntityDiff<Offer>;
+}

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);