@managesome/eposmatic-toolkit 0.3.8 → 0.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (437) hide show
  1. package/esm/constants/ANALYTICS.js +146 -0
  2. package/esm/constants/API_ERRORS.js +6 -0
  3. package/esm/constants/COMMON.js +369 -0
  4. package/esm/constants/DELIVERY.js +45 -0
  5. package/esm/constants/DIALER_ENUMS.js +11 -0
  6. package/esm/constants/ENUMS.js +1988 -0
  7. package/esm/constants/FBR_ENUMS.js +18 -0
  8. package/esm/constants/HUBRISE_ENUMS.js +179 -0
  9. package/esm/constants/INTERNAL_ENUMS.js +49 -0
  10. package/esm/constants/NOTIFICATIONS.js +6 -0
  11. package/esm/constants/ORDER.js +251 -0
  12. package/esm/constants/PRA_ENUMS.js +18 -0
  13. package/esm/constants/REPORT_WEBVIEW.js +28 -0
  14. package/esm/constants/RFQ_GO.js +83 -0
  15. package/esm/constants/SMARTPAY_ENUMS.js +55 -0
  16. package/esm/constants/SOCKET.js +149 -0
  17. package/esm/constants/SRB_ENUMS.js +13 -0
  18. package/esm/constants/SWITCHPAY.js +28 -0
  19. package/esm/constants/TENANT_ENUMS.js +90 -0
  20. package/esm/constants/TENANT_PURCHASE_ORDER.js +91 -0
  21. package/esm/constants/WALLET.js +51 -0
  22. package/esm/constants/WAREHOUSE_ANALYTICS.js +28 -0
  23. package/esm/constants/WAREHOUSE_ENUMS.js +420 -0
  24. package/esm/constants/WAREHOUSE_PURCHASE_ORDER.js +97 -0
  25. package/esm/constants/WEBVIEW.js +43 -0
  26. package/esm/constants/WORKER_ENDPOINTS.js +79 -0
  27. package/esm/constants/index.js +27 -0
  28. package/esm/constants/types.js +2 -0
  29. package/esm/helpers/fbr/generate-invoice.js +94 -0
  30. package/esm/helpers/fbr/index.js +1 -0
  31. package/esm/helpers/hubrise/hubrise-catalog.js +304 -0
  32. package/esm/helpers/hubrise/index.js +1 -0
  33. package/esm/helpers/index.js +9 -0
  34. package/esm/helpers/kpra/generate-invoice.js +26 -0
  35. package/esm/helpers/kpra/index.js +1 -0
  36. package/esm/helpers/order/generate-order.js +508 -0
  37. package/esm/helpers/order/generate-warehouse-internal-movement.js +71 -0
  38. package/esm/helpers/order/generate-warehouse-purchase-order-rfq.js +176 -0
  39. package/esm/helpers/order/generate-warehouse-purchase-order.js +187 -0
  40. package/esm/helpers/order/generate-warehouse-sale-order-rfq.js +176 -0
  41. package/esm/helpers/order/generate-warehouse-sale-order.js +149 -0
  42. package/esm/helpers/order/index.js +6 -0
  43. package/esm/helpers/pra/generate-invoice.js +94 -0
  44. package/esm/helpers/pra/index.js +1 -0
  45. package/esm/helpers/srb/generate-invoice.js +68 -0
  46. package/esm/helpers/srb/index.js +1 -0
  47. package/esm/helpers/store/all-orders-actions.js +17 -0
  48. package/esm/helpers/store/all-tenant-purchase-orders-actions.js +45 -0
  49. package/esm/helpers/store/all-warehouse-purchase-order-rfqs-actions.js +66 -0
  50. package/esm/helpers/store/all-warehouse-purchase-order-vendor-return-actions.js +50 -0
  51. package/esm/helpers/store/all-warehouse-purchase-orders-actions.js +49 -0
  52. package/esm/helpers/store/all-warehouse-sale-order-invoices-actions.js +132 -0
  53. package/esm/helpers/store/all-warehouse-sale-order-rfqs-actions.js +66 -0
  54. package/esm/helpers/store/all-warehouse-sale-orders-actions.js +72 -0
  55. package/esm/helpers/store/cart-actions.js +3563 -0
  56. package/esm/helpers/store/catalog-actions.js +379 -0
  57. package/esm/helpers/store/common-order-actions.js +937 -0
  58. package/esm/helpers/store/common-tenant-purchase-order-actions.js +440 -0
  59. package/esm/helpers/store/common-warehouse-internal-movement-actions.js +95 -0
  60. package/esm/helpers/store/common-warehouse-purchase-order-actions.js +530 -0
  61. package/esm/helpers/store/common-warehouse-purchase-order-receipt-actions.js +33 -0
  62. package/esm/helpers/store/common-warehouse-purchase-order-rfq-actions.js +523 -0
  63. package/esm/helpers/store/common-warehouse-purchase-order-vendor-return-actions.js +25 -0
  64. package/esm/helpers/store/common-warehouse-sale-order-actions.js +483 -0
  65. package/esm/helpers/store/common-warehouse-sale-order-invoice-actions.js +54 -0
  66. package/esm/helpers/store/common-warehouse-sale-order-rfq-actions.js +523 -0
  67. package/esm/helpers/store/index.js +26 -0
  68. package/esm/helpers/store/offline-ordering.js +251 -0
  69. package/esm/helpers/store/tenant-purchase-orders-cart-actions.js +379 -0
  70. package/esm/helpers/store/warehouse-purchase-order-rfq-cart-actions.js +360 -0
  71. package/esm/helpers/store/warehouse-purchase-orders-cart-actions.js +470 -0
  72. package/esm/helpers/store/warehouse-sale-order-rfq-cart-actions.js +359 -0
  73. package/esm/helpers/store/warehouse-sale-orders-cart-actions.js +456 -0
  74. package/esm/helpers/types/api-types.js +1 -0
  75. package/esm/helpers/types/cart-actions.js +1 -0
  76. package/esm/helpers/types/cart-helpers.js +1 -0
  77. package/esm/helpers/types/catalog.js +1 -0
  78. package/esm/helpers/types/common.js +1 -0
  79. package/esm/helpers/types/deliverect_menu.js +1 -0
  80. package/esm/helpers/types/email-templates.js +1 -0
  81. package/esm/helpers/types/fbr-generate-invoice.js +1 -0
  82. package/esm/helpers/types/halfhalf.js +1 -0
  83. package/esm/helpers/types/hubrise_catalog.js +1 -0
  84. package/esm/helpers/types/hubrise_customers.js +1 -0
  85. package/esm/helpers/types/hubrise_deliveries.js +1 -0
  86. package/esm/helpers/types/hubrise_location.js +1 -0
  87. package/esm/helpers/types/hubrise_orders.js +1 -0
  88. package/esm/helpers/types/index.js +33 -0
  89. package/esm/helpers/types/internal-leads.js +1 -0
  90. package/esm/helpers/types/inventory-catalog.js +1 -0
  91. package/esm/helpers/types/kpra-generate-invoice.js +1 -0
  92. package/esm/helpers/types/marketing.js +1 -0
  93. package/esm/helpers/types/order-engine.js +1 -0
  94. package/esm/helpers/types/pra-generate-invoice.js +1 -0
  95. package/esm/helpers/types/report-webview.js +1 -0
  96. package/esm/helpers/types/reports.js +1 -0
  97. package/esm/helpers/types/smartpay-apis.js +2 -0
  98. package/esm/helpers/types/specials.js +1 -0
  99. package/esm/helpers/types/split_bill.js +1 -0
  100. package/esm/helpers/types/srb-generate-invoice.js +1 -0
  101. package/esm/helpers/types/switchpay.js +1 -0
  102. package/esm/helpers/types/tenant-purchase-order-cart-actions.js +1 -0
  103. package/esm/helpers/types/warehouse-catalog.js +1 -0
  104. package/esm/helpers/types/warehouse-purchase-order-cart-actions.js +1 -0
  105. package/esm/helpers/types/warehouse-purchase-order-rfq-cart-actions.js +1 -0
  106. package/esm/helpers/types/warehouse-sale-order-cart-actions.js +1 -0
  107. package/esm/helpers/types/warehouse-sale-order-rfq-cart-actions.js +1 -0
  108. package/esm/helpers/types/workers.js +1 -0
  109. package/esm/helpers/utils/asaanbill-identifier-helpers.js +31 -0
  110. package/esm/helpers/utils/business-day-helpers.js +201 -0
  111. package/esm/helpers/utils/cart-helpers.js +156 -0
  112. package/esm/helpers/utils/catalog-conversion.js +129 -0
  113. package/esm/helpers/utils/code-redemption-helpers.js +452 -0
  114. package/esm/helpers/utils/color-helpers.js +31 -0
  115. package/esm/helpers/utils/common.js +368 -0
  116. package/esm/helpers/utils/crypt.js +40 -0
  117. package/esm/helpers/utils/customers-helpers.js +15 -0
  118. package/esm/helpers/utils/delivery-area-helpers.js +42 -0
  119. package/esm/helpers/utils/delivery-helpers.js +87 -0
  120. package/esm/helpers/utils/denominations-helpers.js +53 -0
  121. package/esm/helpers/utils/dinein.js +39 -0
  122. package/esm/helpers/utils/discount-helpers.js +55 -0
  123. package/esm/helpers/utils/email-helpers.js +111 -0
  124. package/esm/helpers/utils/error-helpers.js +14 -0
  125. package/esm/helpers/utils/expense.js +26 -0
  126. package/esm/helpers/utils/getFormFieldsDiff.js +15 -0
  127. package/esm/helpers/utils/gift-card-helpers.js +258 -0
  128. package/esm/helpers/utils/halfhalf-setup-helpers.js +779 -0
  129. package/esm/helpers/utils/hourly-comparison-report-helpers.js +851 -0
  130. package/esm/helpers/utils/hr-helpers.js +62 -0
  131. package/esm/helpers/utils/hubrise-utils.js +32 -0
  132. package/esm/helpers/utils/image-helpers.js +95 -0
  133. package/esm/helpers/utils/image-url-helpers.js +96 -0
  134. package/esm/helpers/utils/index.js +96 -0
  135. package/esm/helpers/utils/ingredients.js +26 -0
  136. package/esm/helpers/utils/internal-amount-helpers.js +49 -0
  137. package/esm/helpers/utils/inventory.js +123 -0
  138. package/esm/helpers/utils/inventory_entries.js +91 -0
  139. package/esm/helpers/utils/inventory_transactions.js +91 -0
  140. package/esm/helpers/utils/item-report-helpers.js +2603 -0
  141. package/esm/helpers/utils/items-comparison-report-helpers.js +1057 -0
  142. package/esm/helpers/utils/kds-helpers.js +43 -0
  143. package/esm/helpers/utils/location-helpers.js +13 -0
  144. package/esm/helpers/utils/menu-helpers.js +44 -0
  145. package/esm/helpers/utils/minified-catalog.js +428 -0
  146. package/esm/helpers/utils/offer-apply-helpers.js +613 -0
  147. package/esm/helpers/utils/offers-helpers.js +3351 -0
  148. package/esm/helpers/utils/operational-roles-helpers.js +33 -0
  149. package/esm/helpers/utils/order-engine.js +1409 -0
  150. package/esm/helpers/utils/order-history.js +208 -0
  151. package/esm/helpers/utils/payment-comparison-report-helpers.js +873 -0
  152. package/esm/helpers/utils/payment-helpers.js +302 -0
  153. package/esm/helpers/utils/pdf-generator.js +110 -0
  154. package/esm/helpers/utils/platform-catalog.js +306 -0
  155. package/esm/helpers/utils/platform-num.js +188 -0
  156. package/esm/helpers/utils/platform-specific-tenant-shifts.js +19 -0
  157. package/esm/helpers/utils/price-conversion.js +24 -0
  158. package/esm/helpers/utils/printer-helpers.js +319 -0
  159. package/esm/helpers/utils/public-holidays-helpers.js +8 -0
  160. package/esm/helpers/utils/ratings-comparison-report-helpers.js +1187 -0
  161. package/esm/helpers/utils/receipt-engine.js +1050 -0
  162. package/esm/helpers/utils/review-helpers.js +391 -0
  163. package/esm/helpers/utils/rider-tracking.js +12 -0
  164. package/esm/helpers/utils/riders-report-helpers.js +1590 -0
  165. package/esm/helpers/utils/sales-comparison-report-helpers.js +1259 -0
  166. package/esm/helpers/utils/sales-comparitive-report-helpers.js +939 -0
  167. package/esm/helpers/utils/sales-overview-report-helpers.js +1046 -0
  168. package/esm/helpers/utils/sales-summary-report-helpers.js +877 -0
  169. package/esm/helpers/utils/scan-code-helpers.js +31 -0
  170. package/esm/helpers/utils/selection-model.js +68 -0
  171. package/esm/helpers/utils/shift-window-helpers.js +148 -0
  172. package/esm/helpers/utils/simplified-catalog.js +107 -0
  173. package/esm/helpers/utils/simplified-halfhalf.js +101 -0
  174. package/esm/helpers/utils/simplified-specials.js +107 -0
  175. package/esm/helpers/utils/simplified-tenant.js +411 -0
  176. package/esm/helpers/utils/specials-helpers.js +727 -0
  177. package/esm/helpers/utils/tenant-calendar-helpers.js +67 -0
  178. package/esm/helpers/utils/tenant-cash-drawer-sessions-helpers.js +248 -0
  179. package/esm/helpers/utils/tenant-cash-drawers-helpers.js +31 -0
  180. package/esm/helpers/utils/tenant-cash-in-out-helpers.js +47 -0
  181. package/esm/helpers/utils/tenant-day-sessions-helpers.js +167 -0
  182. package/esm/helpers/utils/tenant-instore-shift-sessions-helpers.js +227 -0
  183. package/esm/helpers/utils/tenant-staff-helpers.js +19 -0
  184. package/esm/helpers/utils/tenant_cash_in_hand_transactions.js +31 -0
  185. package/esm/helpers/utils/time-helpers.js +142 -0
  186. package/esm/helpers/utils/void-items-report-helpers.js +529 -0
  187. package/esm/helpers/utils/void-order-items-helpers.js +32 -0
  188. package/esm/helpers/utils/voidations-summary-report-helpers.js +800 -0
  189. package/esm/helpers/utils/wallet-helpers.js +22 -0
  190. package/esm/helpers/utils/wallet-redemption-helpers.js +46 -0
  191. package/esm/helpers/utils/warehouse-catalog-conversion.js +117 -0
  192. package/esm/helpers/utils/warehouse-inventory.js +59 -0
  193. package/esm/helpers/utils/warehouse-purchase-order-engine.js +27 -0
  194. package/esm/helpers/utils/warehouse-purchase-order-receipt-engine.js +205 -0
  195. package/esm/helpers/utils/warehouse-purchase-order-x-report-helpers.js +1432 -0
  196. package/esm/helpers/utils/warehouse-sale-order-engine.js +27 -0
  197. package/esm/helpers/utils/warehouse-sale-order-receipt-engine.js +207 -0
  198. package/esm/helpers/utils/warehouse-sale-order-x-report-helpers.js +1 -0
  199. package/esm/helpers/utils/warehouse-sale-x-report-helpers.js +1434 -0
  200. package/esm/helpers/utils/warehouse-settings-helpers.js +37 -0
  201. package/esm/helpers/utils/warehouse-void-purchase-order-items-helpers.js +34 -0
  202. package/esm/helpers/utils/warehouse-void-purchase-order-items-report-helpers.js +18 -0
  203. package/esm/helpers/utils/warehouse-void-sale-order-items-helpers.js +34 -0
  204. package/esm/helpers/utils/warehouse-void-sale-order-items-report-helpers.js +18 -0
  205. package/esm/helpers/utils/warehouse_inventory_transactions.js +91 -0
  206. package/esm/helpers/utils/x-report-helpers.js +1850 -0
  207. package/esm/index.js +3 -0
  208. package/esm/schemas/index.js +2 -0
  209. package/esm/schemas/models/app_configs.js +36 -0
  210. package/esm/schemas/models/applied_order_discounts.js +103 -0
  211. package/esm/schemas/models/brands.js +56 -0
  212. package/esm/schemas/models/categories.js +74 -0
  213. package/esm/schemas/models/close_dates.js +63 -0
  214. package/esm/schemas/models/common-models.js +449 -0
  215. package/esm/schemas/models/courses.js +62 -0
  216. package/esm/schemas/models/customer_redemptions.js +82 -0
  217. package/esm/schemas/models/customers.js +269 -0
  218. package/esm/schemas/models/deliveries.js +137 -0
  219. package/esm/schemas/models/delivery_areas.js +97 -0
  220. package/esm/schemas/models/dinein_floors.js +55 -0
  221. package/esm/schemas/models/dinein_tables.js +97 -0
  222. package/esm/schemas/models/dinein_tables_fingerprints.js +96 -0
  223. package/esm/schemas/models/discounts.js +87 -0
  224. package/esm/schemas/models/expense_categories.js +61 -0
  225. package/esm/schemas/models/expense_details.js +130 -0
  226. package/esm/schemas/models/gift_cards.js +342 -0
  227. package/esm/schemas/models/halfhalf_setup.js +142 -0
  228. package/esm/schemas/models/index.js +111 -0
  229. package/esm/schemas/models/internal_customers.js +139 -0
  230. package/esm/schemas/models/internal_invoices.js +119 -0
  231. package/esm/schemas/models/internal_leads.js +78 -0
  232. package/esm/schemas/models/internal_operational_roles.js +85 -0
  233. package/esm/schemas/models/internal_staffs.js +65 -0
  234. package/esm/schemas/models/inventories.js +103 -0
  235. package/esm/schemas/models/inventory_categories.js +52 -0
  236. package/esm/schemas/models/inventory_transactions.js +143 -0
  237. package/esm/schemas/models/item_transactions.js +117 -0
  238. package/esm/schemas/models/items.js +341 -0
  239. package/esm/schemas/models/marketing_fingerprints.js +92 -0
  240. package/esm/schemas/models/menus.js +66 -0
  241. package/esm/schemas/models/messaging_devices.js +99 -0
  242. package/esm/schemas/models/modifier_extras.js +120 -0
  243. package/esm/schemas/models/offers.js +470 -0
  244. package/esm/schemas/models/offers_fingerprints.js +61 -0
  245. package/esm/schemas/models/operational_roles.js +155 -0
  246. package/esm/schemas/models/orders.js +1051 -0
  247. package/esm/schemas/models/printer_settings.js +245 -0
  248. package/esm/schemas/models/public_holidays.js +58 -0
  249. package/esm/schemas/models/reservations.js +127 -0
  250. package/esm/schemas/models/reviews.js +145 -0
  251. package/esm/schemas/models/rewards_usage.js +61 -0
  252. package/esm/schemas/models/riders.js +75 -0
  253. package/esm/schemas/models/specials.js +169 -0
  254. package/esm/schemas/models/staff_shifts.js +66 -0
  255. package/esm/schemas/models/tenant-activity-logs.js +126 -0
  256. package/esm/schemas/models/tenant_active_jobs.js +77 -0
  257. package/esm/schemas/models/tenant_calendar.js +89 -0
  258. package/esm/schemas/models/tenant_cash_drawer_sessions.js +208 -0
  259. package/esm/schemas/models/tenant_cash_drawers.js +60 -0
  260. package/esm/schemas/models/tenant_cash_in_hand_transactions.js +69 -0
  261. package/esm/schemas/models/tenant_cash_in_out.js +104 -0
  262. package/esm/schemas/models/tenant_clients.js +66 -0
  263. package/esm/schemas/models/tenant_day_sessions.js +166 -0
  264. package/esm/schemas/models/tenant_hr_attendance_records.js +87 -0
  265. package/esm/schemas/models/tenant_hr_biometric_enrollments.js +69 -0
  266. package/esm/schemas/models/tenant_hr_departments.js +42 -0
  267. package/esm/schemas/models/tenant_hr_documents.js +71 -0
  268. package/esm/schemas/models/tenant_hr_employees.js +172 -0
  269. package/esm/schemas/models/tenant_hr_leave_requests.js +80 -0
  270. package/esm/schemas/models/tenant_hr_payrolls.js +131 -0
  271. package/esm/schemas/models/tenant_hr_performance_reviews.js +58 -0
  272. package/esm/schemas/models/tenant_hr_policies.js +57 -0
  273. package/esm/schemas/models/tenant_hr_positions.js +48 -0
  274. package/esm/schemas/models/tenant_hr_shift_schedules.js +84 -0
  275. package/esm/schemas/models/tenant_hr_shifts.js +64 -0
  276. package/esm/schemas/models/tenant_instore_shift_sessions.js +204 -0
  277. package/esm/schemas/models/tenant_instore_shifts.js +63 -0
  278. package/esm/schemas/models/tenant_inventory_department_transactions.js +116 -0
  279. package/esm/schemas/models/tenant_inventory_department_utilities.js +85 -0
  280. package/esm/schemas/models/tenant_inventory_departments.js +55 -0
  281. package/esm/schemas/models/tenant_inventory_entries.js +131 -0
  282. package/esm/schemas/models/tenant_metadata.js +88 -0
  283. package/esm/schemas/models/tenant_order_item_instructions.js +66 -0
  284. package/esm/schemas/models/tenant_purchase_order_vendor_returns.js +80 -0
  285. package/esm/schemas/models/tenant_purchase_orders.js +158 -0
  286. package/esm/schemas/models/tenant_shifts.js +57 -0
  287. package/esm/schemas/models/tenant_staffs.js +129 -0
  288. package/esm/schemas/models/tenant_vendors.js +99 -0
  289. package/esm/schemas/models/tenants.js +811 -0
  290. package/esm/schemas/models/terminal_devices.js +63 -0
  291. package/esm/schemas/models/tokens.js +73 -0
  292. package/esm/schemas/models/track_order_numbers.js +42 -0
  293. package/esm/schemas/models/void_order_items.js +210 -0
  294. package/esm/schemas/models/vouchers.js +101 -0
  295. package/esm/schemas/models/wallet_transactions.js +128 -0
  296. package/esm/schemas/models/wallets.js +44 -0
  297. package/esm/schemas/models/warehouse-activity-logs.js +144 -0
  298. package/esm/schemas/models/warehouse_categories.js +83 -0
  299. package/esm/schemas/models/warehouse_clients.js +81 -0
  300. package/esm/schemas/models/warehouse_communications.js +226 -0
  301. package/esm/schemas/models/warehouse_internal_movements.js +463 -0
  302. package/esm/schemas/models/warehouse_inventory_entries.js +125 -0
  303. package/esm/schemas/models/warehouse_inventory_lot_serial_numbers.js +188 -0
  304. package/esm/schemas/models/warehouse_inventory_transactions.js +133 -0
  305. package/esm/schemas/models/warehouse_item_transactions.js +97 -0
  306. package/esm/schemas/models/warehouse_items.js +173 -0
  307. package/esm/schemas/models/warehouse_operational_roles.js +87 -0
  308. package/esm/schemas/models/warehouse_purchase_order_receipts.js +163 -0
  309. package/esm/schemas/models/warehouse_purchase_order_rfqs.js +339 -0
  310. package/esm/schemas/models/warehouse_purchase_order_vendor_returns.js +199 -0
  311. package/esm/schemas/models/warehouse_purchase_orders.js +334 -0
  312. package/esm/schemas/models/warehouse_sale_deliveries.js +155 -0
  313. package/esm/schemas/models/warehouse_sale_invoices.js +229 -0
  314. package/esm/schemas/models/warehouse_sale_order_rfqs.js +340 -0
  315. package/esm/schemas/models/warehouse_sale_orders.js +322 -0
  316. package/esm/schemas/models/warehouse_staffs.js +104 -0
  317. package/esm/schemas/models/warehouse_track_order_numbers.js +73 -0
  318. package/esm/schemas/models/warehouse_vendors.js +99 -0
  319. package/esm/schemas/models/warehouse_void_purchase_order_items.js +174 -0
  320. package/esm/schemas/models/warehouse_void_sale_order_items.js +174 -0
  321. package/esm/schemas/models/warehouses.js +253 -0
  322. package/esm/schemas/types/app_configs.js +1 -0
  323. package/esm/schemas/types/applied_order_discounts.js +1 -0
  324. package/esm/schemas/types/brands.js +1 -0
  325. package/esm/schemas/types/categories.js +1 -0
  326. package/esm/schemas/types/close_dates.js +1 -0
  327. package/esm/schemas/types/common.js +1 -0
  328. package/esm/schemas/types/courses.js +1 -0
  329. package/esm/schemas/types/customer_redemptions.js +1 -0
  330. package/esm/schemas/types/customers.js +1 -0
  331. package/esm/schemas/types/deliveries.js +1 -0
  332. package/esm/schemas/types/delivery_areas.js +1 -0
  333. package/esm/schemas/types/dinein_floors.js +1 -0
  334. package/esm/schemas/types/dinein_tables.js +1 -0
  335. package/esm/schemas/types/dinein_tables_fingerprints.js +1 -0
  336. package/esm/schemas/types/discounts.js +1 -0
  337. package/esm/schemas/types/expense_categories.js +1 -0
  338. package/esm/schemas/types/expense_details.js +1 -0
  339. package/esm/schemas/types/gift_cards.js +1 -0
  340. package/esm/schemas/types/halfhalf_setup.js +1 -0
  341. package/esm/schemas/types/index.js +113 -0
  342. package/esm/schemas/types/internal_customers.js +1 -0
  343. package/esm/schemas/types/internal_invoices.js +1 -0
  344. package/esm/schemas/types/internal_leads.js +1 -0
  345. package/esm/schemas/types/internal_operational_roles.js +16 -0
  346. package/esm/schemas/types/internal_staffs.js +1 -0
  347. package/esm/schemas/types/inventories.js +1 -0
  348. package/esm/schemas/types/inventory_categories.js +1 -0
  349. package/esm/schemas/types/inventory_department_transactions.js +1 -0
  350. package/esm/schemas/types/inventory_department_utilities.js +1 -0
  351. package/esm/schemas/types/inventory_departments.js +1 -0
  352. package/esm/schemas/types/inventory_transactions.js +1 -0
  353. package/esm/schemas/types/item_transactions.js +1 -0
  354. package/esm/schemas/types/items.js +1 -0
  355. package/esm/schemas/types/marketing_fingerprints.js +1 -0
  356. package/esm/schemas/types/menus.js +1 -0
  357. package/esm/schemas/types/messaging_devices.js +1 -0
  358. package/esm/schemas/types/modifier_extras.js +1 -0
  359. package/esm/schemas/types/multi_tenants.js +1 -0
  360. package/esm/schemas/types/offers.js +1 -0
  361. package/esm/schemas/types/offers_fingerprints.js +1 -0
  362. package/esm/schemas/types/operational_roles.js +15 -0
  363. package/esm/schemas/types/orders.js +1 -0
  364. package/esm/schemas/types/printer_settings.js +1 -0
  365. package/esm/schemas/types/public_holidays.js +1 -0
  366. package/esm/schemas/types/reservations.js +1 -0
  367. package/esm/schemas/types/reviews.js +1 -0
  368. package/esm/schemas/types/rewards_usage.js +1 -0
  369. package/esm/schemas/types/riders.js +1 -0
  370. package/esm/schemas/types/specials.js +1 -0
  371. package/esm/schemas/types/staff_shifts.js +1 -0
  372. package/esm/schemas/types/tenant-activity-logs.js +1 -0
  373. package/esm/schemas/types/tenant_active_jobs.js +1 -0
  374. package/esm/schemas/types/tenant_calendar.js +1 -0
  375. package/esm/schemas/types/tenant_cash_drawer_sessions.js +1 -0
  376. package/esm/schemas/types/tenant_cash_drawers.js +1 -0
  377. package/esm/schemas/types/tenant_cash_in_hand_transactions.js +1 -0
  378. package/esm/schemas/types/tenant_cash_in_out.js +1 -0
  379. package/esm/schemas/types/tenant_clients.js +1 -0
  380. package/esm/schemas/types/tenant_day_sessions.js +1 -0
  381. package/esm/schemas/types/tenant_hr_attendance_records.js +1 -0
  382. package/esm/schemas/types/tenant_hr_biometric_enrollments.js +1 -0
  383. package/esm/schemas/types/tenant_hr_departments.js +1 -0
  384. package/esm/schemas/types/tenant_hr_documents.js +1 -0
  385. package/esm/schemas/types/tenant_hr_employees.js +1 -0
  386. package/esm/schemas/types/tenant_hr_leave_requests.js +1 -0
  387. package/esm/schemas/types/tenant_hr_payrolls.js +1 -0
  388. package/esm/schemas/types/tenant_hr_performance_reviews.js +1 -0
  389. package/esm/schemas/types/tenant_hr_policies.js +1 -0
  390. package/esm/schemas/types/tenant_hr_positions.js +1 -0
  391. package/esm/schemas/types/tenant_hr_shift_schedules.js +1 -0
  392. package/esm/schemas/types/tenant_hr_shifts.js +1 -0
  393. package/esm/schemas/types/tenant_instore_shift_sessions.js +1 -0
  394. package/esm/schemas/types/tenant_instore_shifts.js +1 -0
  395. package/esm/schemas/types/tenant_inventory_entries.js +1 -0
  396. package/esm/schemas/types/tenant_metadata.js +1 -0
  397. package/esm/schemas/types/tenant_order_item_instructions.js +1 -0
  398. package/esm/schemas/types/tenant_purchase_order_vendor_returns.js +1 -0
  399. package/esm/schemas/types/tenant_purchase_orders.js +1 -0
  400. package/esm/schemas/types/tenant_shifts.js +1 -0
  401. package/esm/schemas/types/tenant_staffs.js +1 -0
  402. package/esm/schemas/types/tenant_vendors.js +1 -0
  403. package/esm/schemas/types/tenants.js +1 -0
  404. package/esm/schemas/types/terminal_devices.js +1 -0
  405. package/esm/schemas/types/tokens.js +1 -0
  406. package/esm/schemas/types/track_order_numbers.js +1 -0
  407. package/esm/schemas/types/void_order_items.js +1 -0
  408. package/esm/schemas/types/vouchers.js +1 -0
  409. package/esm/schemas/types/wallet_transactions.js +1 -0
  410. package/esm/schemas/types/wallets.js +1 -0
  411. package/esm/schemas/types/warehouse-activity-logs.js +1 -0
  412. package/esm/schemas/types/warehouse_categories.js +1 -0
  413. package/esm/schemas/types/warehouse_clients.js +1 -0
  414. package/esm/schemas/types/warehouse_communications.js +1 -0
  415. package/esm/schemas/types/warehouse_internal_movements.js +1 -0
  416. package/esm/schemas/types/warehouse_inventory_entries.js +1 -0
  417. package/esm/schemas/types/warehouse_inventory_lot_serial_numbers.js +1 -0
  418. package/esm/schemas/types/warehouse_inventory_transactions.js +1 -0
  419. package/esm/schemas/types/warehouse_item_transactions.js +1 -0
  420. package/esm/schemas/types/warehouse_items.js +1 -0
  421. package/esm/schemas/types/warehouse_operational_roles.js +15 -0
  422. package/esm/schemas/types/warehouse_purchase_order_receipts.js +18 -0
  423. package/esm/schemas/types/warehouse_purchase_order_rfqs.js +1 -0
  424. package/esm/schemas/types/warehouse_purchase_order_vendor_returns.js +1 -0
  425. package/esm/schemas/types/warehouse_purchase_orders.js +1 -0
  426. package/esm/schemas/types/warehouse_sale_deliveries.js +1 -0
  427. package/esm/schemas/types/warehouse_sale_invoices.js +1 -0
  428. package/esm/schemas/types/warehouse_sale_order_rfqs.js +1 -0
  429. package/esm/schemas/types/warehouse_sale_orders.js +1 -0
  430. package/esm/schemas/types/warehouse_staffs.js +1 -0
  431. package/esm/schemas/types/warehouse_track_order_numbers.js +1 -0
  432. package/esm/schemas/types/warehouse_vendors.js +1 -0
  433. package/esm/schemas/types/warehouse_void_purchase_order_items.js +1 -0
  434. package/esm/schemas/types/warehouse_void_sale_order_items.js +1 -0
  435. package/esm/schemas/types/warehouses.js +1 -0
  436. package/lib/helpers/types/api-types.d.ts +37 -0
  437. package/package.json +6 -3
@@ -0,0 +1,1051 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_DAY_INDEX, ALL_GIFT_CARD_REWARD_TYPES, ALL_MODIFIER_OPTION_REF_TYPES, ALL_ORDER_ITEM_TYPES, ALL_ORDER_STATUS_NAMES, ALL_PAYMENT_METHOD_EXPECTED, ALL_PLATFORMS, ALL_SPLIT_BILL_TYPES, ORDER_ITEM_TYPE_ENUM, } from '../../constants';
3
+ import { PaymentsSchema } from './common-models';
4
+ const OrderCourseSchema = new Schema({
5
+ name: {
6
+ type: String,
7
+ required: true,
8
+ },
9
+ course_id: {
10
+ type: String, // Should be defined as ObjectId in rules
11
+ required: true,
12
+ },
13
+ item_ids: {
14
+ type: [String], // Should be defined as ObjectId in rules
15
+ default: [],
16
+ },
17
+ called: {
18
+ type: Boolean,
19
+ default: false,
20
+ },
21
+ }, { _id: false, minimize: false });
22
+ const ConsumerSchema = new Schema({
23
+ email: {
24
+ type: String,
25
+ default: '', // Required ✅
26
+ },
27
+ first_name: {
28
+ type: String,
29
+ default: '', // Required ✅
30
+ },
31
+ last_name: {
32
+ type: String,
33
+ default: '', // Required ✅
34
+ },
35
+ phone: {
36
+ type: String,
37
+ default: '', // Required ✅
38
+ },
39
+ }, { _id: false, minimize: false });
40
+ const TakeawayDetailsSchema = new Schema({
41
+ estimated_takeaway_time: {
42
+ type: Date,
43
+ default: null,
44
+ },
45
+ }, { _id: false, minimize: false });
46
+ const StaffDetailsSchema = new Schema({
47
+ staff_id: {
48
+ type: String,
49
+ required: true,
50
+ },
51
+ staff_name: {
52
+ type: String,
53
+ default: '',
54
+ },
55
+ staff_mobile: {
56
+ type: String,
57
+ default: null,
58
+ },
59
+ staff_email: {
60
+ type: String,
61
+ default: null,
62
+ },
63
+ }, { _id: false, minimize: false });
64
+ const DineInDetailsSchema = new Schema({
65
+ floor_id: {
66
+ type: Schema.Types.ObjectId,
67
+ required: true,
68
+ ref: 'floors',
69
+ },
70
+ table_id: {
71
+ type: Schema.Types.ObjectId,
72
+ required: true,
73
+ ref: 'tables',
74
+ },
75
+ table_name: {
76
+ type: String,
77
+ default: '',
78
+ },
79
+ num_of_guests: {
80
+ type: Number,
81
+ min: 1,
82
+ required: true,
83
+ },
84
+ start_time: {
85
+ type: Date,
86
+ required: true,
87
+ },
88
+ reservation_time: {
89
+ type: Date,
90
+ required: true,
91
+ },
92
+ prep_minutes: {
93
+ type: Number,
94
+ required: false,
95
+ },
96
+ courses: {
97
+ type: [OrderCourseSchema],
98
+ default: null,
99
+ },
100
+ }, { _id: false, minimize: false });
101
+ const DeliveryDetailsSchema = new Schema({
102
+ city: {
103
+ type: String,
104
+ default: '',
105
+ },
106
+ address_instructions: {
107
+ type: String,
108
+ default: '', // Required ✅
109
+ },
110
+ state: {
111
+ type: String,
112
+ default: '',
113
+ },
114
+ street: {
115
+ type: String,
116
+ default: '',
117
+ },
118
+ lat: {
119
+ type: Number,
120
+ required: true,
121
+ },
122
+ lng: {
123
+ type: Number,
124
+ required: true,
125
+ },
126
+ zip_code: {
127
+ type: String,
128
+ default: '',
129
+ },
130
+ country_code: {
131
+ type: String,
132
+ default: '',
133
+ },
134
+ delivery_code: {
135
+ type: String,
136
+ default: '',
137
+ },
138
+ delivery_cost: {
139
+ type: Number,
140
+ min: 0,
141
+ required: true,
142
+ },
143
+ rider_revenue: {
144
+ type: Number,
145
+ min: 0,
146
+ required: false,
147
+ },
148
+ estimated_delivery_time: {
149
+ type: Date,
150
+ default: null,
151
+ },
152
+ distance_in_meters_from_store: {
153
+ type: Number,
154
+ default: 0,
155
+ },
156
+ rider_details: {
157
+ type: StaffDetailsSchema,
158
+ required: false,
159
+ },
160
+ }, { _id: false, minimize: false });
161
+ const DiscountDetailsSchema = new Schema({
162
+ voucher_discount: {
163
+ type: Number,
164
+ min: 0,
165
+ },
166
+ voucher_discount_id: {
167
+ type: String,
168
+ },
169
+ voucher_discount_name: {
170
+ type: String,
171
+ },
172
+ is_voucher_discount_percentage: {
173
+ type: Boolean,
174
+ },
175
+ voucher_discount_reason: {
176
+ type: String,
177
+ },
178
+ voucher_reference_number: {
179
+ type: String,
180
+ },
181
+ special_discount: {
182
+ type: Number,
183
+ },
184
+ special_discount_id: {
185
+ type: String,
186
+ },
187
+ special_discount_name: {
188
+ type: String,
189
+ },
190
+ is_special_discount_percentage: {
191
+ type: Boolean,
192
+ },
193
+ special_discount_reason: {
194
+ type: String,
195
+ },
196
+ special_reference_number: {
197
+ type: String,
198
+ },
199
+ loyalty_discount: {
200
+ type: Number,
201
+ min: 0,
202
+ },
203
+ loyalty_discount_id: {
204
+ type: String,
205
+ },
206
+ loyalty_discount_name: {
207
+ type: String,
208
+ },
209
+ is_loyalty_discount_percentage: {
210
+ type: Boolean,
211
+ },
212
+ loyalty_discount_reason: {
213
+ type: String,
214
+ },
215
+ loyalty_reference_number: {
216
+ type: String,
217
+ },
218
+ total_discount: {
219
+ type: Number,
220
+ required: true,
221
+ },
222
+ }, { _id: false, minimize: false });
223
+ const GiftCardRedemptionSchema = new Schema({
224
+ gift_card_id: {
225
+ type: String,
226
+ required: true,
227
+ },
228
+ mystery_gift_type: {
229
+ type: String,
230
+ enum: ALL_GIFT_CARD_REWARD_TYPES,
231
+ required: false,
232
+ },
233
+ redeemed_times: {
234
+ type: Number,
235
+ min: 0,
236
+ required: true,
237
+ },
238
+ }, { _id: false, minimize: false });
239
+ const WalletRedemptionsSchema = new Schema({
240
+ cashback_amount: {
241
+ type: Number,
242
+ min: 0,
243
+ required: false,
244
+ },
245
+ gift_cards: {
246
+ type: [GiftCardRedemptionSchema],
247
+ required: false,
248
+ },
249
+ }, { _id: false, minimize: false });
250
+ const OptionsSchema = new Schema({
251
+ _id: {
252
+ type: String,
253
+ required: true,
254
+ immutable: true,
255
+ },
256
+ ref: {
257
+ type: String,
258
+ required: true,
259
+ immutable: true,
260
+ },
261
+ name: {
262
+ type: String,
263
+ required: true,
264
+ },
265
+ price: {
266
+ type: Number,
267
+ min: 0,
268
+ required: true,
269
+ },
270
+ quantity: {
271
+ type: Number,
272
+ min: 1,
273
+ required: true,
274
+ },
275
+ is_free: {
276
+ type: Boolean,
277
+ default: false,
278
+ },
279
+ ref_type: {
280
+ type: String,
281
+ enum: ALL_MODIFIER_OPTION_REF_TYPES,
282
+ required: false,
283
+ },
284
+ });
285
+ export const OrderItemModifiersSchema = new Schema({
286
+ _id: {
287
+ type: String,
288
+ required: true,
289
+ immutable: true,
290
+ },
291
+ ref: {
292
+ type: String,
293
+ required: true,
294
+ immutable: true,
295
+ },
296
+ name: {
297
+ type: String,
298
+ required: true,
299
+ },
300
+ options: {
301
+ type: [OptionsSchema],
302
+ default: [],
303
+ },
304
+ });
305
+ const ItemsModal = new Schema({
306
+ _id: {
307
+ type: Schema.Types.ObjectId,
308
+ required: true,
309
+ immutable: true,
310
+ },
311
+ item_id: {
312
+ type: Schema.Types.ObjectId,
313
+ required: true,
314
+ immutable: true,
315
+ },
316
+ menu_id: {
317
+ type: Schema.Types.ObjectId,
318
+ default: null,
319
+ },
320
+ item_type: {
321
+ type: String,
322
+ enum: ALL_ORDER_ITEM_TYPES,
323
+ required: true,
324
+ default: ORDER_ITEM_TYPE_ENUM.ITEM,
325
+ },
326
+ is_ready: {
327
+ type: Boolean,
328
+ required: false,
329
+ },
330
+ void_reason: {
331
+ type: String,
332
+ required: false,
333
+ },
334
+ seat_number: {
335
+ type: Number,
336
+ required: false,
337
+ },
338
+ is_split: {
339
+ type: Boolean,
340
+ required: false,
341
+ },
342
+ moved_to_order_id: {
343
+ type: Schema.Types.ObjectId,
344
+ required: false,
345
+ },
346
+ moved_from_order_id: {
347
+ type: Schema.Types.ObjectId,
348
+ required: false,
349
+ },
350
+ ready_minutes: {
351
+ type: Number,
352
+ required: false,
353
+ },
354
+ prep_started_at: {
355
+ type: Date,
356
+ required: false,
357
+ },
358
+ name: {
359
+ type: String,
360
+ required: true,
361
+ },
362
+ price: {
363
+ type: Number,
364
+ min: 0,
365
+ required: true,
366
+ },
367
+ subtotal: {
368
+ type: Number,
369
+ min: 0,
370
+ required: true,
371
+ },
372
+ tax_rate: {
373
+ type: Number,
374
+ min: 0,
375
+ required: true,
376
+ },
377
+ quantity: {
378
+ type: Number,
379
+ min: 0,
380
+ required: true,
381
+ },
382
+ _gst_amount: {
383
+ type: Number,
384
+ min: 0,
385
+ required: true,
386
+ },
387
+ _net_amount: {
388
+ type: Number,
389
+ min: 0,
390
+ required: true,
391
+ },
392
+ _gross_amount: {
393
+ type: Number,
394
+ min: 0,
395
+ required: true,
396
+ },
397
+ _discount_amount: {
398
+ type: Number,
399
+ min: 0,
400
+ required: true,
401
+ },
402
+ special_instructions: {
403
+ type: String,
404
+ default: '',
405
+ },
406
+ item_discount_details: {
407
+ type: DiscountDetailsSchema,
408
+ default: null,
409
+ },
410
+ modifiers: {
411
+ type: [OrderItemModifiersSchema],
412
+ default: null,
413
+ },
414
+ });
415
+ const CatergoriesSchema = new Schema({
416
+ category_id: {
417
+ type: Schema.Types.ObjectId,
418
+ required: true,
419
+ immutable: true,
420
+ ref: 'categories',
421
+ },
422
+ name: {
423
+ type: String,
424
+ required: true,
425
+ },
426
+ items: {
427
+ type: [ItemsModal],
428
+ default: [],
429
+ },
430
+ }, {
431
+ _id: false,
432
+ minimize: false,
433
+ });
434
+ const IterationsOrderSchema = new Schema({
435
+ consumer: {
436
+ type: ConsumerSchema,
437
+ required: true,
438
+ },
439
+ platform: {
440
+ type: String,
441
+ enum: ALL_PLATFORMS,
442
+ required: true,
443
+ },
444
+ tip_amount: {
445
+ type: Number,
446
+ min: 0,
447
+ required: true,
448
+ },
449
+ categories: {
450
+ type: [CatergoriesSchema],
451
+ required: true,
452
+ },
453
+ special_instructions: {
454
+ type: String,
455
+ default: '',
456
+ },
457
+ payments: {
458
+ type: [PaymentsSchema],
459
+ required: true,
460
+ },
461
+ order_status: {
462
+ type: String,
463
+ enum: ALL_ORDER_STATUS_NAMES,
464
+ required: true,
465
+ },
466
+ tax_number: {
467
+ type: String,
468
+ default: '',
469
+ },
470
+ tax_amount: {
471
+ type: Number,
472
+ min: 0,
473
+ required: true,
474
+ },
475
+ price: {
476
+ type: Number,
477
+ min: 0,
478
+ required: true,
479
+ },
480
+ amount_earned: {
481
+ type: Number,
482
+ min: 0,
483
+ required: true,
484
+ },
485
+ grand_total: {
486
+ type: Number,
487
+ min: 0,
488
+ required: true,
489
+ },
490
+ updatedAt: {
491
+ type: Schema.Types.Date,
492
+ required: true,
493
+ },
494
+ // common fields
495
+ delivery_details: {
496
+ type: DeliveryDetailsSchema,
497
+ required: false,
498
+ },
499
+ dinein_details: {
500
+ type: DineInDetailsSchema,
501
+ required: false,
502
+ },
503
+ takeaway_details: {
504
+ type: TakeawayDetailsSchema,
505
+ required: false,
506
+ },
507
+ staff_details: {
508
+ type: StaffDetailsSchema,
509
+ required: false,
510
+ },
511
+ order_taker_details: {
512
+ type: StaffDetailsSchema,
513
+ required: false,
514
+ },
515
+ order_discount_details: {
516
+ type: DiscountDetailsSchema,
517
+ required: false,
518
+ },
519
+ total_discount_applied: {
520
+ type: Number,
521
+ required: false,
522
+ },
523
+ is_surcharge_percentage: {
524
+ type: Boolean,
525
+ required: false,
526
+ },
527
+ is_surcharge_taxable: {
528
+ type: Boolean,
529
+ required: false,
530
+ },
531
+ surcharge: {
532
+ type: Number,
533
+ min: 0,
534
+ required: false,
535
+ },
536
+ surcharge_amount: {
537
+ type: Number,
538
+ min: 0,
539
+ required: false,
540
+ },
541
+ is_service_fee_percentage: {
542
+ type: Boolean,
543
+ required: false,
544
+ },
545
+ is_service_fee_taxable: {
546
+ type: Boolean,
547
+ required: false,
548
+ },
549
+ service_fee: {
550
+ type: Number,
551
+ min: 0,
552
+ required: false,
553
+ },
554
+ service_fee_amount: {
555
+ type: Number,
556
+ min: 0,
557
+ required: false,
558
+ },
559
+ gst: {
560
+ type: Number,
561
+ min: 0,
562
+ required: false,
563
+ },
564
+ exclude_discount_from_gst: {
565
+ type: Boolean,
566
+ required: false,
567
+ },
568
+ gst_amount: {
569
+ type: Number,
570
+ min: 0,
571
+ required: false,
572
+ },
573
+ packaging_charges: {
574
+ type: Number,
575
+ min: 0,
576
+ required: false,
577
+ },
578
+ adjustment_amount: {
579
+ type: Number,
580
+ required: false,
581
+ },
582
+ adjustment_reason: {
583
+ type: String,
584
+ required: false,
585
+ },
586
+ apply_service_fee_on_original_price: {
587
+ type: Boolean,
588
+ required: false,
589
+ },
590
+ is_gst_inclusive: {
591
+ type: Boolean,
592
+ required: false,
593
+ },
594
+ tax_invoice_provider_charges: {
595
+ type: Number,
596
+ min: 0,
597
+ required: false,
598
+ },
599
+ //
600
+ }, {
601
+ _id: false,
602
+ timestamps: false,
603
+ versionKey: false,
604
+ });
605
+ export const OrderSchema = new Schema({
606
+ _id: {
607
+ type: Schema.Types.ObjectId,
608
+ required: true,
609
+ immutable: true,
610
+ },
611
+ tenant_id: {
612
+ type: String,
613
+ required: true,
614
+ ref: 'tenants',
615
+ // NOTE: This is not immutable because we need to change the tenant_id when we move the order to another tenant
616
+ },
617
+ source_tenant_id: {
618
+ type: String,
619
+ required: false,
620
+ },
621
+ pos_id: {
622
+ type: String,
623
+ default: null,
624
+ },
625
+ consumer: {
626
+ type: ConsumerSchema,
627
+ required: true,
628
+ },
629
+ platform: {
630
+ type: String,
631
+ enum: ALL_PLATFORMS,
632
+ required: true,
633
+ },
634
+ tip_amount: {
635
+ type: Number,
636
+ min: 0,
637
+ required: true,
638
+ },
639
+ categories: {
640
+ type: [CatergoriesSchema],
641
+ default: [],
642
+ },
643
+ iterations: {
644
+ type: [IterationsOrderSchema],
645
+ default: [],
646
+ },
647
+ special_instructions: {
648
+ type: String,
649
+ default: '',
650
+ },
651
+ payments: {
652
+ type: [PaymentsSchema],
653
+ required: true,
654
+ },
655
+ split_parent_id: {
656
+ type: Schema.Types.ObjectId,
657
+ required: false,
658
+ },
659
+ split_child_ids: {
660
+ type: [Schema.Types.ObjectId],
661
+ required: false,
662
+ default: undefined,
663
+ },
664
+ split_type: {
665
+ type: String,
666
+ enum: ALL_SPLIT_BILL_TYPES,
667
+ required: false,
668
+ },
669
+ order_status: {
670
+ type: String,
671
+ enum: ALL_ORDER_STATUS_NAMES,
672
+ required: true,
673
+ },
674
+ tax_number: {
675
+ type: String,
676
+ default: '',
677
+ },
678
+ tax_amount: {
679
+ type: Number,
680
+ min: 0,
681
+ default: 0,
682
+ },
683
+ price: {
684
+ type: Number,
685
+ min: 0,
686
+ required: true,
687
+ },
688
+ amount_collected: {
689
+ type: Number,
690
+ min: 0,
691
+ required: true,
692
+ },
693
+ amount_earned: {
694
+ type: Number,
695
+ min: 0,
696
+ required: true,
697
+ },
698
+ grand_total: {
699
+ type: Number,
700
+ min: 0,
701
+ required: true,
702
+ },
703
+ order_number: {
704
+ type: Number,
705
+ min: 0,
706
+ default: null,
707
+ },
708
+ //
709
+ delete_reason: {
710
+ type: String,
711
+ required: false,
712
+ },
713
+ cancel_reason: {
714
+ type: String,
715
+ required: false,
716
+ },
717
+ tax_invoice_id: {
718
+ type: String,
719
+ required: false,
720
+ },
721
+ is_deleted: {
722
+ type: Boolean,
723
+ default: false,
724
+ },
725
+ // common fields
726
+ delivery_details: {
727
+ type: DeliveryDetailsSchema,
728
+ required: false,
729
+ },
730
+ dinein_details: {
731
+ type: DineInDetailsSchema,
732
+ required: false,
733
+ },
734
+ takeaway_details: {
735
+ type: TakeawayDetailsSchema,
736
+ required: false,
737
+ },
738
+ staff_details: {
739
+ type: StaffDetailsSchema,
740
+ required: false,
741
+ },
742
+ order_discount_details: {
743
+ type: DiscountDetailsSchema,
744
+ required: false,
745
+ },
746
+ total_discount_applied: {
747
+ type: Number,
748
+ required: false,
749
+ },
750
+ is_surcharge_percentage: {
751
+ type: Boolean,
752
+ required: false,
753
+ },
754
+ is_surcharge_taxable: {
755
+ type: Boolean,
756
+ required: false,
757
+ },
758
+ surcharge: {
759
+ type: Number,
760
+ min: 0,
761
+ required: false,
762
+ },
763
+ surcharge_amount: {
764
+ type: Number,
765
+ min: 0,
766
+ required: false,
767
+ },
768
+ is_service_fee_percentage: {
769
+ type: Boolean,
770
+ required: false,
771
+ },
772
+ is_service_fee_taxable: {
773
+ type: Boolean,
774
+ required: false,
775
+ },
776
+ service_fee: {
777
+ type: Number,
778
+ min: 0,
779
+ required: false,
780
+ },
781
+ service_fee_amount: {
782
+ type: Number,
783
+ min: 0,
784
+ required: false,
785
+ },
786
+ gst: {
787
+ type: Number,
788
+ min: 0,
789
+ required: false,
790
+ },
791
+ exclude_discount_from_gst: {
792
+ type: Boolean,
793
+ required: false,
794
+ },
795
+ gst_amount: {
796
+ type: Number,
797
+ min: 0,
798
+ required: false,
799
+ },
800
+ packaging_charges: {
801
+ type: Number,
802
+ min: 0,
803
+ required: false,
804
+ },
805
+ adjustment_amount: {
806
+ type: Number,
807
+ required: false,
808
+ },
809
+ adjustment_reason: {
810
+ type: String,
811
+ required: false,
812
+ },
813
+ apply_service_fee_on_original_price: {
814
+ type: Boolean,
815
+ required: false,
816
+ },
817
+ is_gst_inclusive: {
818
+ type: Boolean,
819
+ required: false,
820
+ },
821
+ tax_invoice_provider_charges: {
822
+ type: Number,
823
+ min: 0,
824
+ required: false,
825
+ },
826
+ //
827
+ order_status_updated_at: {
828
+ type: Schema.Types.Date,
829
+ required: true,
830
+ default: () => new Date(),
831
+ },
832
+ rating: {
833
+ type: Number,
834
+ min: 0,
835
+ max: 5,
836
+ required: false,
837
+ },
838
+ review: {
839
+ type: String,
840
+ required: false,
841
+ },
842
+ synced_offline: {
843
+ type: Boolean,
844
+ required: false,
845
+ },
846
+ is_reopened: {
847
+ type: Boolean,
848
+ required: false,
849
+ },
850
+ is_unpaid: {
851
+ type: Boolean,
852
+ required: false,
853
+ },
854
+ deferred_settlement: {
855
+ type: Boolean,
856
+ required: false,
857
+ },
858
+ payment_method_expected: {
859
+ type: String,
860
+ enum: ALL_PAYMENT_METHOD_EXPECTED,
861
+ required: false,
862
+ },
863
+ order_taker_details: {
864
+ type: StaffDetailsSchema,
865
+ required: false,
866
+ },
867
+ redeemed_offers: {
868
+ type: Map,
869
+ of: Number,
870
+ required: false,
871
+ },
872
+ wallet_redemptions: {
873
+ type: WalletRedemptionsSchema,
874
+ required: false,
875
+ },
876
+ order_settled_at: {
877
+ type: Schema.Types.Date,
878
+ required: true,
879
+ default: () => new Date(),
880
+ },
881
+ order_settled_at_mins: {
882
+ type: Number,
883
+ required: true,
884
+ default: () => {
885
+ const date = new Date();
886
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
887
+ },
888
+ },
889
+ // local time fields (Partial<ILocalTimeFields>)
890
+ // copied from LocalTimeFieldsSchema
891
+ day_index: {
892
+ type: String,
893
+ enum: ALL_DAY_INDEX,
894
+ required: false,
895
+ },
896
+ localSecond: {
897
+ type: Number,
898
+ required: false,
899
+ min: 0,
900
+ max: 59,
901
+ },
902
+ localMinute: {
903
+ type: Number,
904
+ required: false,
905
+ min: 0,
906
+ max: 59,
907
+ },
908
+ localHour: {
909
+ type: Number,
910
+ required: false,
911
+ min: 0,
912
+ max: 23,
913
+ },
914
+ localDay: {
915
+ type: Number,
916
+ required: false,
917
+ min: 0,
918
+ max: 6,
919
+ },
920
+ localWeek: {
921
+ type: Number,
922
+ required: false,
923
+ min: 1,
924
+ max: 5,
925
+ },
926
+ localWeekOfYear: {
927
+ type: Number,
928
+ required: false,
929
+ min: 1,
930
+ max: 53,
931
+ },
932
+ localMonth: {
933
+ type: Number,
934
+ required: false,
935
+ min: 1,
936
+ max: 12,
937
+ },
938
+ localQuarter: {
939
+ type: Number,
940
+ required: false,
941
+ min: 1,
942
+ max: 4,
943
+ },
944
+ localSemester: {
945
+ type: Number,
946
+ required: false,
947
+ min: 1,
948
+ max: 2,
949
+ },
950
+ localYear: {
951
+ type: Number,
952
+ required: false,
953
+ },
954
+ localDate: {
955
+ type: String,
956
+ required: false,
957
+ },
958
+ localTime: {
959
+ type: String,
960
+ required: false,
961
+ },
962
+ localDayOfYear: {
963
+ type: Number,
964
+ required: false,
965
+ min: 1,
966
+ max: 366,
967
+ },
968
+ createdAt_mins: {
969
+ type: Number,
970
+ required: true,
971
+ immutable: true,
972
+ default: () => {
973
+ const date = new Date();
974
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
975
+ },
976
+ },
977
+ createdAt: {
978
+ type: Schema.Types.Date,
979
+ required: true,
980
+ default: () => new Date(),
981
+ immutable: true,
982
+ },
983
+ updatedAt: {
984
+ type: Schema.Types.Date,
985
+ required: true,
986
+ default: () => new Date(),
987
+ },
988
+ }, {
989
+ timestamps: true,
990
+ versionKey: false,
991
+ minimize: false,
992
+ });
993
+ OptionsSchema.add({
994
+ modifiers: {
995
+ type: [OrderItemModifiersSchema],
996
+ default: null,
997
+ },
998
+ });
999
+ export const ORDERS_COLLECTION_NAME = 'orders';
1000
+ /**
1001
+ * Describes the indexes for `orders`. Values are Mongo key patterns that can be
1002
+ * passed straight to `.hint()`.
1003
+ * - `_id`: unique primary key.
1004
+ * - `tenant_id__is_deleted__deferred_settlement__createdAt`: PARTIAL index —
1005
+ * create with `partialFilterExpression: { deferred_settlement: true }` (only
1006
+ * credit bills / credit-tab orders are indexed; every query using this hint
1007
+ * filters deferred_settlement: true and typically is_deleted: false).
1008
+ * Supports per-tenant credit-bill lookups newest first via created_at desc.
1009
+ * - `source_tenant_id__is_deleted__createdAt`: PARTIAL index —
1010
+ * create with `partialFilterExpression: { source_tenant_id: { $exists: true } }`
1011
+ * (source_tenant_id is an optional string). Supports per-source-tenant order
1012
+ * lookups filtered by is_deleted, newest first.
1013
+ * - `tenant_id__is_deleted__consumer.phone__createdAt`: per-tenant order
1014
+ * lookups by consumer phone, filtered by is_deleted, newest first.
1015
+ * - `tenant_id__is_deleted__deferred_settlement__consumer.phone__createdAt`:
1016
+ * per-tenant credit-bill (deferred settlement) order lookups by consumer
1017
+ * phone, filtered by is_deleted, newest first.
1018
+ */
1019
+ export const ORDERS_COLLECTION_INDEXES = {
1020
+ _id: { _id: 1 }, // Unique Index
1021
+ source_tenant_id__is_deleted__createdAt: {
1022
+ source_tenant_id: 1,
1023
+ is_deleted: 1,
1024
+ createdAt: -1,
1025
+ }, // partial index (partialFilterExpression: { source_tenant_id: { $exists: true } }) — per-source-tenant order lookups filtered by is_deleted, newest first
1026
+ tenant_id__is_deleted__deferred_settlement__createdAt: {
1027
+ tenant_id: 1,
1028
+ is_deleted: 1,
1029
+ deferred_settlement: 1,
1030
+ createdAt: -1,
1031
+ }, // partial index (partialFilterExpression: { deferred_settlement: true }) — active open bills per tenant, newest first
1032
+ tenant_id__is_deleted__localDate__createdAt: {
1033
+ tenant_id: 1,
1034
+ is_deleted: 1,
1035
+ localDate: 1,
1036
+ createdAt: -1,
1037
+ }, // partial index (partialFilterExpression: { localDate: { $exists: true } }) — per-tenant local-date order lookups filtered by is_deleted, newest first
1038
+ tenant_id__is_deleted__consumer_phone__createdAt: {
1039
+ tenant_id: 1,
1040
+ is_deleted: 1,
1041
+ 'consumer.phone': 1,
1042
+ createdAt: -1,
1043
+ }, // per-tenant order lookups by consumer phone, filtered by is_deleted, newest first
1044
+ tenant_id__is_deleted__deferred_settlement__consumer_phone__createdAt: {
1045
+ tenant_id: 1,
1046
+ is_deleted: 1,
1047
+ deferred_settlement: 1,
1048
+ 'consumer.phone': 1,
1049
+ createdAt: -1,
1050
+ }, // per-tenant credit-bill (deferred settlement) order lookups by consumer phone, filtered by is_deleted, newest first
1051
+ };