@managesome/eposmatic-toolkit 0.3.7 → 0.3.9

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 (439) 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/utils/order-engine.js +6 -1
  437. package/lib/tests/soldout-option-default-guard.test.d.ts +1 -0
  438. package/lib/tests/soldout-option-default-guard.test.js +126 -0
  439. package/package.json +6 -3
@@ -0,0 +1,163 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_WAREHOUSE_PURCHASE_ORDER_RECEIPT_STATUS_NAMES, WAREHOUSE_PURCHASE_ORDER_RECEIPT_STATUS_ENUM, } from '../../constants';
3
+ import { WAREHOUSE_ITEMS_COLLECTION_NAME } from './warehouse_items';
4
+ import { WAREHOUSE_PURCHASE_ORDER_COLLECTION_NAME } from './warehouse_purchase_orders';
5
+ import { WAREHOUSE_VENDORS_COLLECTION_NAME } from './warehouse_vendors';
6
+ import { WAREHOUSE_SETTINGS_COLLECTION_NAME } from './warehouses';
7
+ const PurchaseOrderReceiptCreatedBySchema = new Schema({
8
+ _id: {
9
+ type: String,
10
+ required: true,
11
+ },
12
+ name: {
13
+ type: String,
14
+ required: true,
15
+ default: '',
16
+ },
17
+ }, { _id: false, minimize: false });
18
+ const PurchaseOrderReceiptItemsSchema = new Schema({
19
+ _id: {
20
+ type: Schema.Types.ObjectId,
21
+ required: true,
22
+ immutable: true,
23
+ },
24
+ item_id: {
25
+ type: Schema.Types.ObjectId,
26
+ required: true,
27
+ immutable: true,
28
+ ref: WAREHOUSE_ITEMS_COLLECTION_NAME,
29
+ },
30
+ name: {
31
+ type: String,
32
+ required: true,
33
+ },
34
+ ordered_quantity: {
35
+ type: Number,
36
+ min: 0,
37
+ required: true,
38
+ },
39
+ received_quantity: {
40
+ type: Number,
41
+ min: 0,
42
+ required: true,
43
+ },
44
+ price: {
45
+ type: Number,
46
+ min: 0,
47
+ required: true,
48
+ },
49
+ subtotal: {
50
+ type: Number,
51
+ min: 0,
52
+ required: true,
53
+ },
54
+ }, {
55
+ _id: false,
56
+ minimize: false,
57
+ });
58
+ export const PurchaseOrderReceiptsSchema = new Schema({
59
+ _id: {
60
+ type: Schema.Types.ObjectId,
61
+ required: true,
62
+ immutable: true,
63
+ },
64
+ warehouse_id: {
65
+ type: String,
66
+ required: true,
67
+ ref: WAREHOUSE_SETTINGS_COLLECTION_NAME,
68
+ },
69
+ purchase_order_id: {
70
+ type: Schema.Types.ObjectId,
71
+ required: true,
72
+ ref: WAREHOUSE_PURCHASE_ORDER_COLLECTION_NAME,
73
+ },
74
+ vendor_id: {
75
+ type: Schema.Types.ObjectId,
76
+ required: true,
77
+ ref: WAREHOUSE_VENDORS_COLLECTION_NAME,
78
+ },
79
+ vendor_name: {
80
+ type: String,
81
+ default: '',
82
+ },
83
+ receipt_status: {
84
+ type: String,
85
+ enum: ALL_WAREHOUSE_PURCHASE_ORDER_RECEIPT_STATUS_NAMES,
86
+ required: true,
87
+ default: WAREHOUSE_PURCHASE_ORDER_RECEIPT_STATUS_ENUM.DRAFT,
88
+ },
89
+ items: {
90
+ type: [PurchaseOrderReceiptItemsSchema],
91
+ required: true,
92
+ default: [],
93
+ },
94
+ total_received_amount: {
95
+ type: Number,
96
+ min: 0,
97
+ required: true,
98
+ },
99
+ notes: {
100
+ type: String,
101
+ required: false,
102
+ },
103
+ created_by: {
104
+ type: PurchaseOrderReceiptCreatedBySchema,
105
+ required: false,
106
+ },
107
+ validated_by: {
108
+ type: PurchaseOrderReceiptCreatedBySchema,
109
+ required: false,
110
+ },
111
+ validated_at: {
112
+ type: Schema.Types.Date,
113
+ required: false,
114
+ },
115
+ cancelled_at: {
116
+ type: Schema.Types.Date,
117
+ required: false,
118
+ },
119
+ cancel_reason: {
120
+ type: String,
121
+ required: false,
122
+ },
123
+ createdAt_mins: {
124
+ type: Number,
125
+ required: true,
126
+ immutable: true,
127
+ default: () => {
128
+ const date = new Date();
129
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
130
+ },
131
+ },
132
+ createdAt: {
133
+ type: Schema.Types.Date,
134
+ required: true,
135
+ default: () => new Date(),
136
+ immutable: true,
137
+ },
138
+ updatedAt: {
139
+ type: Schema.Types.Date,
140
+ required: true,
141
+ default: () => new Date(),
142
+ },
143
+ }, {
144
+ timestamps: true,
145
+ versionKey: false,
146
+ minimize: false,
147
+ });
148
+ export const WAREHOUSE_PURCHASE_ORDER_RECEIPTS_COLLECTION_NAME = 'purchase_order_receipts';
149
+ /**
150
+ * Describes the indexes for `purchase_order_receipts`. Values are Mongo key
151
+ * patterns that can be passed straight to `.hint()`.
152
+ * - `_id`: unique primary key.
153
+ * - `warehouse_id__purchase_order_id__receipt_status`: receipt lookups by
154
+ * purchase order, scoped by receipt status.
155
+ */
156
+ export const WAREHOUSE_PURCHASE_ORDER_RECEIPTS_COLLECTION_INDEXES = {
157
+ _id: { _id: 1 }, // Unique Index
158
+ warehouse_id__purchase_order_id__receipt_status: {
159
+ warehouse_id: 1,
160
+ purchase_order_id: 1,
161
+ receipt_status: 1,
162
+ }, // receipt lookups by purchase order, scoped by receipt status
163
+ };
@@ -0,0 +1,339 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_WAREHOUSE_PURCHASE_ORDER_RFQ_STATUS_NAMES, ALL_WAREHOUSE_RFQ_VENDOR_STATUS_NAMES, WAREHOUSE_PURCHASE_ORDER_RFQ_STATUS_ENUM, WAREHOUSE_PURCHASE_ORDER_RFQ_VENDOR_STATUS_ENUM, } from '../../constants';
3
+ import { WAREHOUSE_CATEGORY_COLLECTION_NAME } from './warehouse_categories';
4
+ import { WAREHOUSE_ITEMS_COLLECTION_NAME } from './warehouse_items';
5
+ import { WAREHOUSE_VENDORS_COLLECTION_NAME } from './warehouse_vendors';
6
+ import { WAREHOUSE_SETTINGS_COLLECTION_NAME } from './warehouses';
7
+ const StaffDetailsSchema = new Schema({
8
+ staff_id: {
9
+ type: String,
10
+ required: true,
11
+ },
12
+ staff_name: {
13
+ type: String,
14
+ required: false,
15
+ },
16
+ staff_mobile: {
17
+ type: String,
18
+ required: false,
19
+ },
20
+ staff_email: {
21
+ type: String,
22
+ required: false,
23
+ },
24
+ }, { _id: false, minimize: false });
25
+ const PurchaseOrderRFQItemsSchema = new Schema({
26
+ _id: {
27
+ type: Schema.Types.ObjectId,
28
+ required: true,
29
+ immutable: true,
30
+ },
31
+ item_id: {
32
+ type: Schema.Types.ObjectId,
33
+ required: true,
34
+ immutable: true,
35
+ ref: WAREHOUSE_ITEMS_COLLECTION_NAME,
36
+ },
37
+ is_ready: {
38
+ type: Boolean,
39
+ required: false,
40
+ },
41
+ void_reason: {
42
+ type: String,
43
+ required: false,
44
+ },
45
+ name: {
46
+ type: String,
47
+ required: true,
48
+ },
49
+ quantity: {
50
+ type: Number,
51
+ min: 0,
52
+ required: true,
53
+ },
54
+ price: {
55
+ type: Number,
56
+ min: 0,
57
+ required: true,
58
+ },
59
+ subtotal: {
60
+ type: Number,
61
+ min: 0,
62
+ required: true,
63
+ },
64
+ _net_amount: {
65
+ type: Number,
66
+ min: 0,
67
+ required: true,
68
+ },
69
+ _gross_amount: {
70
+ type: Number,
71
+ min: 0,
72
+ required: true,
73
+ },
74
+ _gst_amount: {
75
+ type: Number,
76
+ min: 0,
77
+ required: true,
78
+ },
79
+ _discount_amount: {
80
+ type: Number,
81
+ min: 0,
82
+ required: true,
83
+ },
84
+ special_instructions: {
85
+ type: String,
86
+ required: false,
87
+ },
88
+ }, {
89
+ _id: false,
90
+ minimize: false,
91
+ });
92
+ const PurchaseOrderRFQCategoriesSchema = new Schema({
93
+ category_id: {
94
+ type: Schema.Types.ObjectId,
95
+ required: false,
96
+ default: null,
97
+ immutable: true,
98
+ ref: WAREHOUSE_CATEGORY_COLLECTION_NAME,
99
+ },
100
+ name: {
101
+ type: String,
102
+ required: true,
103
+ },
104
+ items: {
105
+ type: [PurchaseOrderRFQItemsSchema],
106
+ default: [],
107
+ },
108
+ }, {
109
+ _id: false,
110
+ minimize: false,
111
+ });
112
+ const RequestedVendorEntrySchema = new Schema({
113
+ vendor_id: {
114
+ type: Schema.Types.ObjectId,
115
+ required: true,
116
+ ref: WAREHOUSE_VENDORS_COLLECTION_NAME,
117
+ },
118
+ vendor_name: { type: String, required: false },
119
+ vendor_email: { type: String, required: false },
120
+ vendor_price: { type: Number, min: 0, required: false },
121
+ status: {
122
+ type: String,
123
+ enum: ALL_WAREHOUSE_RFQ_VENDOR_STATUS_NAMES,
124
+ default: WAREHOUSE_PURCHASE_ORDER_RFQ_VENDOR_STATUS_ENUM.PENDING,
125
+ },
126
+ }, { _id: false, minimize: false });
127
+ const PurchaseOrderRFQIterationSchema = new Schema({
128
+ categories: {
129
+ type: [PurchaseOrderRFQCategoriesSchema],
130
+ required: true,
131
+ },
132
+ staff_details: {
133
+ type: StaffDetailsSchema,
134
+ required: true,
135
+ },
136
+ special_instructions: {
137
+ type: String,
138
+ required: false,
139
+ },
140
+ price: {
141
+ type: Number,
142
+ min: 0,
143
+ required: true,
144
+ },
145
+ amount_earned: {
146
+ type: Number,
147
+ min: 0,
148
+ required: true,
149
+ },
150
+ grand_total: {
151
+ type: Number,
152
+ min: 0,
153
+ required: true,
154
+ },
155
+ order_status: {
156
+ type: String,
157
+ enum: ALL_WAREHOUSE_PURCHASE_ORDER_RFQ_STATUS_NAMES,
158
+ required: true,
159
+ },
160
+ is_gst_inclusive: {
161
+ type: Boolean,
162
+ required: false,
163
+ },
164
+ gst: {
165
+ type: Number,
166
+ min: 0,
167
+ required: false,
168
+ },
169
+ gst_amount: {
170
+ type: Number,
171
+ min: 0,
172
+ required: false,
173
+ },
174
+ tax_number: {
175
+ type: String,
176
+ required: false,
177
+ },
178
+ updatedAt: {
179
+ type: Schema.Types.Date,
180
+ required: true,
181
+ },
182
+ }, {
183
+ _id: false,
184
+ timestamps: false,
185
+ versionKey: false,
186
+ });
187
+ export const PurchaseOrderRFQSchema = new Schema({
188
+ _id: {
189
+ type: Schema.Types.ObjectId,
190
+ required: true,
191
+ immutable: true,
192
+ },
193
+ warehouse_id: {
194
+ type: String,
195
+ required: true,
196
+ ref: WAREHOUSE_SETTINGS_COLLECTION_NAME,
197
+ },
198
+ vendor_id: {
199
+ type: Schema.Types.ObjectId,
200
+ required: false,
201
+ },
202
+ vendor_name: {
203
+ type: String,
204
+ required: false,
205
+ },
206
+ requested_vendors: {
207
+ type: Map,
208
+ of: RequestedVendorEntrySchema,
209
+ required: false,
210
+ },
211
+ order_number: {
212
+ type: Number,
213
+ min: 0,
214
+ default: null,
215
+ },
216
+ order_status: {
217
+ type: String,
218
+ enum: ALL_WAREHOUSE_PURCHASE_ORDER_RFQ_STATUS_NAMES,
219
+ required: true,
220
+ default: WAREHOUSE_PURCHASE_ORDER_RFQ_STATUS_ENUM.DRAFT,
221
+ },
222
+ categories: {
223
+ type: [PurchaseOrderRFQCategoriesSchema],
224
+ default: [],
225
+ },
226
+ iterations: {
227
+ type: [PurchaseOrderRFQIterationSchema],
228
+ default: [],
229
+ },
230
+ expected_deadline: {
231
+ type: String,
232
+ required: false,
233
+ },
234
+ payment_terms: {
235
+ type: Number,
236
+ min: 0,
237
+ default: 0,
238
+ },
239
+ special_instructions: {
240
+ type: String,
241
+ required: false,
242
+ },
243
+ delete_reason: {
244
+ type: String,
245
+ required: false,
246
+ },
247
+ cancel_reason: {
248
+ type: String,
249
+ required: false,
250
+ },
251
+ staff_details: {
252
+ type: StaffDetailsSchema,
253
+ required: true,
254
+ },
255
+ gst: {
256
+ type: Number,
257
+ min: 0,
258
+ required: false,
259
+ },
260
+ gst_amount: {
261
+ type: Number,
262
+ min: 0,
263
+ required: false,
264
+ },
265
+ is_gst_inclusive: {
266
+ type: Boolean,
267
+ required: false,
268
+ },
269
+ tax_number: {
270
+ type: String,
271
+ required: false,
272
+ },
273
+ is_deleted: {
274
+ type: Boolean,
275
+ default: false,
276
+ },
277
+ order_status_updated_at: {
278
+ type: Schema.Types.Date,
279
+ required: true,
280
+ default: () => new Date(),
281
+ },
282
+ is_reopened: {
283
+ type: Boolean,
284
+ required: false,
285
+ },
286
+ price: {
287
+ type: Number,
288
+ min: 0,
289
+ required: true,
290
+ },
291
+ amount_earned: {
292
+ type: Number,
293
+ min: 0,
294
+ required: true,
295
+ },
296
+ grand_total: {
297
+ type: Number,
298
+ min: 0,
299
+ required: true,
300
+ },
301
+ createdAt_mins: {
302
+ type: Number,
303
+ required: true,
304
+ immutable: true,
305
+ default: () => {
306
+ const date = new Date();
307
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
308
+ },
309
+ },
310
+ createdAt: {
311
+ type: Schema.Types.Date,
312
+ required: true,
313
+ default: () => new Date(),
314
+ immutable: true,
315
+ },
316
+ updatedAt: {
317
+ type: Schema.Types.Date,
318
+ required: true,
319
+ default: () => new Date(),
320
+ },
321
+ }, {
322
+ timestamps: true,
323
+ versionKey: false,
324
+ minimize: false,
325
+ });
326
+ export const WAREHOUSE_PURCHASE_ORDER_RFQ_COLLECTION_NAME = 'purchase_order_rfqs';
327
+ /**
328
+ * Describes the indexes for `purchase_order_rfqs`. Values are Mongo key
329
+ * patterns that can be passed straight to `.hint()`.
330
+ * - `_id`: unique primary key.
331
+ * - `warehouse_id__createdAt`: per-warehouse RFQ lookups newest first.
332
+ */
333
+ export const WAREHOUSE_PURCHASE_ORDER_RFQ_COLLECTION_INDEXES = {
334
+ _id: { _id: 1 }, // Unique Index
335
+ warehouse_id__createdAt: {
336
+ warehouse_id: 1,
337
+ createdAt: -1,
338
+ }, // per-warehouse RFQ lookups newest first
339
+ };
@@ -0,0 +1,199 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_WAREHOUSE_PURCHASE_ORDER_VENDOR_RETURN_STATUS_NAMES, WAREHOUSE_PURCHASE_ORDER_VENDOR_RETURN_STATUS_ENUM, } from '../../constants';
3
+ import { WAREHOUSE_ITEMS_COLLECTION_NAME } from './warehouse_items';
4
+ import { WAREHOUSE_PURCHASE_ORDER_COLLECTION_NAME } from './warehouse_purchase_orders';
5
+ import { WAREHOUSE_VENDORS_COLLECTION_NAME } from './warehouse_vendors';
6
+ import { WAREHOUSE_SETTINGS_COLLECTION_NAME } from './warehouses';
7
+ const PurchaseOrderVendorReturnActorSchema = new Schema({
8
+ _id: {
9
+ type: String,
10
+ required: true,
11
+ },
12
+ name: {
13
+ type: String,
14
+ required: true,
15
+ default: '',
16
+ },
17
+ }, { _id: false, minimize: false });
18
+ const PurchaseOrderVendorReturnItemsSchema = new Schema({
19
+ _id: {
20
+ type: Schema.Types.ObjectId,
21
+ required: true,
22
+ immutable: true,
23
+ },
24
+ item_id: {
25
+ type: Schema.Types.ObjectId,
26
+ required: true,
27
+ immutable: true,
28
+ ref: WAREHOUSE_ITEMS_COLLECTION_NAME,
29
+ },
30
+ name: {
31
+ type: String,
32
+ required: true,
33
+ },
34
+ ordered_quantity: {
35
+ type: Number,
36
+ min: 0,
37
+ required: true,
38
+ },
39
+ return_quantity: {
40
+ type: Number,
41
+ min: 0,
42
+ required: true,
43
+ },
44
+ price: {
45
+ type: Number,
46
+ min: 0,
47
+ required: true,
48
+ },
49
+ subtotal: {
50
+ type: Number,
51
+ min: 0,
52
+ required: true,
53
+ },
54
+ reason: {
55
+ type: String,
56
+ required: false,
57
+ },
58
+ }, {
59
+ _id: false,
60
+ minimize: false,
61
+ });
62
+ export const PurchaseOrderVendorReturnsSchema = new Schema({
63
+ _id: {
64
+ type: Schema.Types.ObjectId,
65
+ required: true,
66
+ immutable: true,
67
+ },
68
+ warehouse_id: {
69
+ type: String,
70
+ required: true,
71
+ ref: WAREHOUSE_SETTINGS_COLLECTION_NAME,
72
+ },
73
+ purchase_order_id: {
74
+ type: Schema.Types.ObjectId,
75
+ required: true,
76
+ ref: WAREHOUSE_PURCHASE_ORDER_COLLECTION_NAME,
77
+ },
78
+ vendor_id: {
79
+ type: Schema.Types.ObjectId,
80
+ required: true,
81
+ ref: WAREHOUSE_VENDORS_COLLECTION_NAME,
82
+ },
83
+ vendor_name: {
84
+ type: String,
85
+ default: '',
86
+ },
87
+ return_status: {
88
+ type: String,
89
+ enum: ALL_WAREHOUSE_PURCHASE_ORDER_VENDOR_RETURN_STATUS_NAMES,
90
+ required: true,
91
+ default: WAREHOUSE_PURCHASE_ORDER_VENDOR_RETURN_STATUS_ENUM.CREATED,
92
+ },
93
+ inventory_consumed: {
94
+ type: Boolean,
95
+ required: true,
96
+ default: false,
97
+ },
98
+ items: {
99
+ type: [PurchaseOrderVendorReturnItemsSchema],
100
+ required: true,
101
+ default: [],
102
+ },
103
+ total_return_amount: {
104
+ type: Number,
105
+ min: 0,
106
+ required: true,
107
+ },
108
+ notes: {
109
+ type: String,
110
+ required: false,
111
+ },
112
+ created_by: {
113
+ type: PurchaseOrderVendorReturnActorSchema,
114
+ required: false,
115
+ },
116
+ approved_by: {
117
+ type: PurchaseOrderVendorReturnActorSchema,
118
+ required: false,
119
+ },
120
+ dispatched_by: {
121
+ type: PurchaseOrderVendorReturnActorSchema,
122
+ required: false,
123
+ },
124
+ vendor_confirmed_by: {
125
+ type: PurchaseOrderVendorReturnActorSchema,
126
+ required: false,
127
+ },
128
+ completed_by: {
129
+ type: PurchaseOrderVendorReturnActorSchema,
130
+ required: false,
131
+ },
132
+ cancelled_by: {
133
+ type: PurchaseOrderVendorReturnActorSchema,
134
+ required: false,
135
+ },
136
+ approved_at: {
137
+ type: Schema.Types.Date,
138
+ required: false,
139
+ },
140
+ dispatched_at: {
141
+ type: Schema.Types.Date,
142
+ required: false,
143
+ },
144
+ vendor_confirmed_at: {
145
+ type: Schema.Types.Date,
146
+ required: false,
147
+ },
148
+ completed_at: {
149
+ type: Schema.Types.Date,
150
+ required: false,
151
+ },
152
+ cancelled_at: {
153
+ type: Schema.Types.Date,
154
+ required: false,
155
+ },
156
+ cancel_reason: {
157
+ type: String,
158
+ required: false,
159
+ },
160
+ createdAt_mins: {
161
+ type: Number,
162
+ required: true,
163
+ immutable: true,
164
+ default: () => {
165
+ const date = new Date();
166
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
167
+ },
168
+ },
169
+ createdAt: {
170
+ type: Schema.Types.Date,
171
+ required: true,
172
+ default: () => new Date(),
173
+ immutable: true,
174
+ },
175
+ updatedAt: {
176
+ type: Schema.Types.Date,
177
+ required: true,
178
+ default: () => new Date(),
179
+ },
180
+ }, {
181
+ timestamps: true,
182
+ versionKey: false,
183
+ minimize: false,
184
+ });
185
+ export const WAREHOUSE_PURCHASE_ORDER_VENDOR_RETURNS_COLLECTION_NAME = 'purchase_order_vendor_returns';
186
+ /**
187
+ * Describes the indexes for `purchase_order_vendor_returns`. Values are Mongo
188
+ * key patterns that can be passed straight to `.hint()`.
189
+ * - `_id`: unique primary key.
190
+ * - `warehouse_id__purchase_order_id`: vendor-return lookups by purchase order,
191
+ * scoped by warehouse.
192
+ */
193
+ export const WAREHOUSE_PURCHASE_ORDER_VENDOR_RETURNS_COLLECTION_INDEXES = {
194
+ _id: { _id: 1 }, // Unique Index
195
+ warehouse_id__purchase_order_id: {
196
+ warehouse_id: 1,
197
+ purchase_order_id: 1,
198
+ }, // vendor-return lookups by purchase order, scoped by warehouse
199
+ };