@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,334 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_WAREHOUSE_PURCHASE_ORDER_STATUS_NAMES, WAREHOUSE_PURCHASE_ORDER_STATUS_ENUM } from '../../constants';
3
+ import { PaymentsSchema } from './common-models';
4
+ import { WAREHOUSE_CATEGORY_COLLECTION_NAME } from './warehouse_categories';
5
+ import { WAREHOUSE_ITEMS_COLLECTION_NAME } from './warehouse_items';
6
+ import { WAREHOUSE_PURCHASE_ORDER_RFQ_COLLECTION_NAME } from './warehouse_purchase_order_rfqs';
7
+ import { WAREHOUSE_VENDORS_COLLECTION_NAME } from './warehouse_vendors';
8
+ import { WAREHOUSE_SETTINGS_COLLECTION_NAME } from './warehouses';
9
+ const StaffDetailsSchema = new Schema({
10
+ staff_id: {
11
+ type: String,
12
+ required: true,
13
+ },
14
+ staff_name: {
15
+ type: String,
16
+ default: '',
17
+ },
18
+ staff_mobile: {
19
+ type: String,
20
+ default: null,
21
+ },
22
+ staff_email: {
23
+ type: String,
24
+ default: null,
25
+ },
26
+ }, { _id: false, minimize: false });
27
+ const ItemsModal = new Schema({
28
+ _id: {
29
+ type: Schema.Types.ObjectId,
30
+ required: true,
31
+ immutable: true,
32
+ },
33
+ item_id: {
34
+ type: Schema.Types.ObjectId,
35
+ required: true,
36
+ immutable: true,
37
+ ref: WAREHOUSE_ITEMS_COLLECTION_NAME,
38
+ },
39
+ is_ready: {
40
+ type: Boolean,
41
+ required: false,
42
+ },
43
+ void_reason: {
44
+ type: String,
45
+ required: false,
46
+ },
47
+ name: {
48
+ type: String,
49
+ required: true,
50
+ },
51
+ price: {
52
+ type: Number,
53
+ min: 0,
54
+ required: true,
55
+ },
56
+ subtotal: {
57
+ type: Number,
58
+ min: 0,
59
+ required: true,
60
+ },
61
+ quantity: {
62
+ type: Number,
63
+ min: 0,
64
+ required: true,
65
+ },
66
+ _gst_amount: {
67
+ type: Number,
68
+ min: 0,
69
+ required: true,
70
+ },
71
+ _net_amount: {
72
+ type: Number,
73
+ min: 0,
74
+ required: true,
75
+ },
76
+ _gross_amount: {
77
+ type: Number,
78
+ min: 0,
79
+ required: true,
80
+ },
81
+ _discount_amount: {
82
+ type: Number,
83
+ min: 0,
84
+ required: true,
85
+ },
86
+ special_instructions: {
87
+ type: String,
88
+ default: '',
89
+ },
90
+ });
91
+ const CatergoriesSchema = new Schema({
92
+ category_id: {
93
+ type: Schema.Types.ObjectId,
94
+ required: false,
95
+ default: null,
96
+ immutable: true,
97
+ ref: WAREHOUSE_CATEGORY_COLLECTION_NAME,
98
+ },
99
+ name: {
100
+ type: String,
101
+ required: true,
102
+ },
103
+ items: {
104
+ type: [ItemsModal],
105
+ default: [],
106
+ },
107
+ }, {
108
+ _id: false,
109
+ minimize: false,
110
+ });
111
+ const IterationsOrderSchema = new Schema({
112
+ categories: {
113
+ type: [CatergoriesSchema],
114
+ required: true,
115
+ },
116
+ special_instructions: {
117
+ type: String,
118
+ default: '',
119
+ },
120
+ payments: {
121
+ type: [PaymentsSchema],
122
+ required: true,
123
+ },
124
+ order_status: {
125
+ type: String,
126
+ enum: ALL_WAREHOUSE_PURCHASE_ORDER_STATUS_NAMES,
127
+ required: true,
128
+ },
129
+ price: {
130
+ type: Number,
131
+ min: 0,
132
+ required: true,
133
+ },
134
+ amount_earned: {
135
+ type: Number,
136
+ min: 0,
137
+ required: true,
138
+ },
139
+ grand_total: {
140
+ type: Number,
141
+ min: 0,
142
+ required: true,
143
+ },
144
+ staff_details: {
145
+ type: StaffDetailsSchema,
146
+ required: false,
147
+ },
148
+ gst: {
149
+ type: Number,
150
+ min: 0,
151
+ required: false,
152
+ },
153
+ gst_amount: {
154
+ type: Number,
155
+ min: 0,
156
+ required: false,
157
+ },
158
+ is_gst_inclusive: {
159
+ type: Boolean,
160
+ required: false,
161
+ },
162
+ tax_number: {
163
+ type: String,
164
+ default: '',
165
+ },
166
+ updatedAt: {
167
+ type: Schema.Types.Date,
168
+ required: true,
169
+ },
170
+ }, {
171
+ _id: false,
172
+ timestamps: false,
173
+ versionKey: false,
174
+ });
175
+ export const PurchaseOrderSchema = new Schema({
176
+ _id: {
177
+ type: Schema.Types.ObjectId,
178
+ required: true,
179
+ immutable: true,
180
+ },
181
+ warehouse_id: {
182
+ type: String,
183
+ required: true,
184
+ ref: WAREHOUSE_SETTINGS_COLLECTION_NAME,
185
+ },
186
+ vendor_id: {
187
+ type: Schema.Types.ObjectId,
188
+ required: true,
189
+ ref: WAREHOUSE_VENDORS_COLLECTION_NAME,
190
+ },
191
+ vendor_name: {
192
+ type: String,
193
+ default: '',
194
+ },
195
+ rfq_id: {
196
+ type: Schema.Types.ObjectId,
197
+ required: false,
198
+ ref: WAREHOUSE_PURCHASE_ORDER_RFQ_COLLECTION_NAME,
199
+ },
200
+ categories: {
201
+ type: [CatergoriesSchema],
202
+ default: [],
203
+ },
204
+ iterations: {
205
+ type: [IterationsOrderSchema],
206
+ default: [],
207
+ },
208
+ special_instructions: {
209
+ type: String,
210
+ default: '',
211
+ },
212
+ payments: {
213
+ type: [PaymentsSchema],
214
+ required: true,
215
+ },
216
+ order_status: {
217
+ type: String,
218
+ enum: ALL_WAREHOUSE_PURCHASE_ORDER_STATUS_NAMES,
219
+ default: WAREHOUSE_PURCHASE_ORDER_STATUS_ENUM.DRAFT,
220
+ },
221
+ tax_number: {
222
+ type: String,
223
+ default: '',
224
+ },
225
+ price: {
226
+ type: Number,
227
+ min: 0,
228
+ required: true,
229
+ },
230
+ amount_collected: {
231
+ type: Number,
232
+ min: 0,
233
+ required: true,
234
+ },
235
+ amount_earned: {
236
+ type: Number,
237
+ min: 0,
238
+ required: true,
239
+ },
240
+ grand_total: {
241
+ type: Number,
242
+ min: 0,
243
+ required: true,
244
+ },
245
+ order_number: {
246
+ type: Number,
247
+ min: 0,
248
+ default: null,
249
+ },
250
+ //
251
+ delete_reason: {
252
+ type: String,
253
+ required: false,
254
+ },
255
+ cancel_reason: {
256
+ type: String,
257
+ required: false,
258
+ },
259
+ // common fields
260
+ staff_details: {
261
+ type: StaffDetailsSchema,
262
+ required: true,
263
+ },
264
+ gst: {
265
+ type: Number,
266
+ min: 0,
267
+ required: false,
268
+ },
269
+ gst_amount: {
270
+ type: Number,
271
+ min: 0,
272
+ required: false,
273
+ },
274
+ is_gst_inclusive: {
275
+ type: Boolean,
276
+ required: false,
277
+ },
278
+ //
279
+ is_deleted: {
280
+ type: Boolean,
281
+ default: false,
282
+ },
283
+ order_status_updated_at: {
284
+ type: Schema.Types.Date,
285
+ required: true,
286
+ default: () => new Date(),
287
+ },
288
+ is_reopened: {
289
+ type: Boolean,
290
+ required: false,
291
+ },
292
+ deferred_settlement: {
293
+ type: Boolean,
294
+ required: false,
295
+ },
296
+ order_settled_at: {
297
+ type: Schema.Types.Date,
298
+ required: true,
299
+ default: () => new Date(),
300
+ },
301
+ order_settled_at_mins: {
302
+ type: Number,
303
+ required: true,
304
+ default: () => {
305
+ const date = new Date();
306
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
307
+ },
308
+ },
309
+ createdAt_mins: {
310
+ type: Number,
311
+ required: true,
312
+ immutable: true,
313
+ default: () => {
314
+ const date = new Date();
315
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
316
+ },
317
+ },
318
+ createdAt: {
319
+ type: Schema.Types.Date,
320
+ required: true,
321
+ default: () => new Date(),
322
+ immutable: true,
323
+ },
324
+ updatedAt: {
325
+ type: Schema.Types.Date,
326
+ required: true,
327
+ default: () => new Date(),
328
+ },
329
+ }, {
330
+ timestamps: true,
331
+ versionKey: false,
332
+ minimize: false,
333
+ });
334
+ export const WAREHOUSE_PURCHASE_ORDER_COLLECTION_NAME = 'purchase_orders';
@@ -0,0 +1,155 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_WAREHOUSE_SALE_ORDER_DELIVERY_RETURN_STATUS_NAMES, ALL_WAREHOUSE_SALE_ORDER_DELIVERY_STATUS_NAMES, ALL_WAREHOUSE_SALE_ORDER_PHYSICAL_DOC_KIND_NAMES, } from '../../constants';
3
+ import { WAREHOUSE_ITEMS_COLLECTION_NAME } from './warehouse_items';
4
+ import { WAREHOUSE_SALE_ORDER_COLLECTION_NAME } from './warehouse_sale_orders';
5
+ import { WAREHOUSE_SETTINGS_COLLECTION_NAME } from './warehouses';
6
+ export const WAREHOUSE_SALE_DELIVERY_COLLECTION_NAME = 'warehouse_sale_deliveries';
7
+ const ALL_WAREHOUSE_SALE_ORDER_PHYSICAL_DOC_STATUS_NAMES = Array.from(new Set([
8
+ ...ALL_WAREHOUSE_SALE_ORDER_DELIVERY_STATUS_NAMES,
9
+ ...ALL_WAREHOUSE_SALE_ORDER_DELIVERY_RETURN_STATUS_NAMES,
10
+ ]));
11
+ const SaleOrderDeliveryActorSchema = new Schema({
12
+ _id: {
13
+ type: String,
14
+ required: true,
15
+ },
16
+ name: {
17
+ type: String,
18
+ default: '',
19
+ },
20
+ }, {
21
+ _id: false,
22
+ minimize: false,
23
+ });
24
+ const SaleOrderDeliveryItemsSchema = new Schema({
25
+ item_id: {
26
+ type: Schema.Types.ObjectId,
27
+ required: true,
28
+ ref: WAREHOUSE_ITEMS_COLLECTION_NAME,
29
+ },
30
+ item_name: {
31
+ type: String,
32
+ required: true,
33
+ },
34
+ quantity: {
35
+ type: Number,
36
+ min: 0,
37
+ required: true,
38
+ },
39
+ reason: {
40
+ type: String,
41
+ required: false,
42
+ },
43
+ }, {
44
+ _id: false,
45
+ minimize: false,
46
+ });
47
+ export const SaleOrderDeliveriesSchema = new Schema({
48
+ _id: {
49
+ type: Schema.Types.ObjectId,
50
+ required: true,
51
+ immutable: true,
52
+ },
53
+ doc_kind: {
54
+ type: String,
55
+ enum: ALL_WAREHOUSE_SALE_ORDER_PHYSICAL_DOC_KIND_NAMES,
56
+ required: true,
57
+ },
58
+ warehouse_id: {
59
+ type: String,
60
+ required: true,
61
+ ref: WAREHOUSE_SETTINGS_COLLECTION_NAME,
62
+ },
63
+ sale_order_id: {
64
+ type: Schema.Types.ObjectId,
65
+ required: true,
66
+ ref: WAREHOUSE_SALE_ORDER_COLLECTION_NAME,
67
+ },
68
+ // Present for delivery-return records.
69
+ applied_to_doc_id: {
70
+ type: Schema.Types.ObjectId,
71
+ required: false,
72
+ ref: WAREHOUSE_SALE_DELIVERY_COLLECTION_NAME,
73
+ },
74
+ items: {
75
+ type: [SaleOrderDeliveryItemsSchema],
76
+ default: [],
77
+ },
78
+ status: {
79
+ type: String,
80
+ enum: ALL_WAREHOUSE_SALE_ORDER_PHYSICAL_DOC_STATUS_NAMES,
81
+ required: true,
82
+ },
83
+ notes: {
84
+ type: String,
85
+ required: false,
86
+ },
87
+ // Delivery-side stock flag.
88
+ inventory_consumed: {
89
+ type: Boolean,
90
+ default: false,
91
+ required: false,
92
+ },
93
+ // Delivery-return-side stock flag.
94
+ inventory_restocked: {
95
+ type: Boolean,
96
+ default: false,
97
+ required: false,
98
+ },
99
+ created_by: {
100
+ type: SaleOrderDeliveryActorSchema,
101
+ required: false,
102
+ },
103
+ delivered_by: {
104
+ type: SaleOrderDeliveryActorSchema,
105
+ required: false,
106
+ },
107
+ returned_by: {
108
+ type: SaleOrderDeliveryActorSchema,
109
+ required: false,
110
+ },
111
+ cancelled_by: {
112
+ type: SaleOrderDeliveryActorSchema,
113
+ required: false,
114
+ },
115
+ delivered_at: {
116
+ type: Schema.Types.Date,
117
+ required: false,
118
+ },
119
+ returned_at: {
120
+ type: Schema.Types.Date,
121
+ required: false,
122
+ },
123
+ cancelled_at: {
124
+ type: Schema.Types.Date,
125
+ required: false,
126
+ },
127
+ cancel_reason: {
128
+ type: String,
129
+ required: false,
130
+ },
131
+ createdAt_mins: {
132
+ type: Number,
133
+ required: true,
134
+ immutable: true,
135
+ default: () => {
136
+ const date = new Date();
137
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
138
+ },
139
+ },
140
+ createdAt: {
141
+ type: Schema.Types.Date,
142
+ required: true,
143
+ default: () => new Date(),
144
+ immutable: true,
145
+ },
146
+ updatedAt: {
147
+ type: Schema.Types.Date,
148
+ required: true,
149
+ default: () => new Date(),
150
+ },
151
+ }, {
152
+ timestamps: true,
153
+ versionKey: false,
154
+ minimize: false,
155
+ });
@@ -0,0 +1,229 @@
1
+ import { Schema } from 'mongoose';
2
+ import { ALL_WAREHOUSE_SALE_ORDER_CREDIT_NOTE_STATUS_NAMES, ALL_WAREHOUSE_SALE_ORDER_FIN_DOC_KIND_NAMES, ALL_WAREHOUSE_SALE_ORDER_INVOICE_PAYMENT_STATUS_NAMES, ALL_WAREHOUSE_SALE_ORDER_INVOICE_TYPE_NAMES, } from '../../constants';
3
+ import { WAREHOUSE_ITEMS_COLLECTION_NAME } from './warehouse_items';
4
+ import { WAREHOUSE_SALE_ORDER_COLLECTION_NAME } from './warehouse_sale_orders';
5
+ import { WAREHOUSE_SETTINGS_COLLECTION_NAME } from './warehouses';
6
+ export const WAREHOUSE_SALE_INVOICE_COLLECTION_NAME = 'warehouse_sale_invoices';
7
+ const ALL_WAREHOUSE_SALE_ORDER_FIN_DOC_STATUS_NAMES = Array.from(new Set([
8
+ ...ALL_WAREHOUSE_SALE_ORDER_INVOICE_PAYMENT_STATUS_NAMES,
9
+ ...ALL_WAREHOUSE_SALE_ORDER_CREDIT_NOTE_STATUS_NAMES,
10
+ ]));
11
+ const WarehouseSaleOrderInvoiceActorSchema = new Schema({
12
+ _id: {
13
+ type: String,
14
+ required: true,
15
+ },
16
+ name: {
17
+ type: String,
18
+ default: '',
19
+ },
20
+ }, {
21
+ _id: false,
22
+ minimize: false,
23
+ });
24
+ const WarehouseSaleOrderInvoiceItemsSchema = new Schema({
25
+ item_id: {
26
+ type: Schema.Types.ObjectId,
27
+ required: true,
28
+ ref: WAREHOUSE_ITEMS_COLLECTION_NAME,
29
+ },
30
+ item_name: {
31
+ type: String,
32
+ required: true,
33
+ },
34
+ quantity: {
35
+ type: Number,
36
+ min: 0,
37
+ required: true,
38
+ },
39
+ unit_price: {
40
+ type: Number,
41
+ min: 0,
42
+ required: true,
43
+ },
44
+ reason: {
45
+ type: String,
46
+ required: false,
47
+ },
48
+ }, {
49
+ _id: false,
50
+ minimize: false,
51
+ });
52
+ export const WarehouseSaleOrderInvoiceSchema = new Schema({
53
+ _id: {
54
+ type: Schema.Types.ObjectId,
55
+ required: true,
56
+ immutable: true,
57
+ },
58
+ doc_kind: {
59
+ type: String,
60
+ enum: ALL_WAREHOUSE_SALE_ORDER_FIN_DOC_KIND_NAMES,
61
+ required: true,
62
+ },
63
+ warehouse_id: {
64
+ type: String,
65
+ required: true,
66
+ ref: WAREHOUSE_SETTINGS_COLLECTION_NAME,
67
+ },
68
+ sale_order_id: {
69
+ type: Schema.Types.ObjectId,
70
+ required: true,
71
+ ref: WAREHOUSE_SALE_ORDER_COLLECTION_NAME,
72
+ },
73
+ doc_number: {
74
+ type: Number,
75
+ min: 0,
76
+ required: true,
77
+ },
78
+ applied_to_doc_id: {
79
+ type: Schema.Types.ObjectId,
80
+ required: false,
81
+ ref: WAREHOUSE_SALE_INVOICE_COLLECTION_NAME,
82
+ },
83
+ items: {
84
+ type: [WarehouseSaleOrderInvoiceItemsSchema],
85
+ default: [],
86
+ },
87
+ amount: {
88
+ type: Number,
89
+ min: 0,
90
+ required: true,
91
+ },
92
+ notes: {
93
+ type: String,
94
+ required: false,
95
+ },
96
+ status: {
97
+ type: String,
98
+ enum: ALL_WAREHOUSE_SALE_ORDER_FIN_DOC_STATUS_NAMES,
99
+ required: true,
100
+ },
101
+ invoice_type: {
102
+ type: String,
103
+ enum: ALL_WAREHOUSE_SALE_ORDER_INVOICE_TYPE_NAMES,
104
+ required: true,
105
+ },
106
+ amount_paid: {
107
+ type: Number,
108
+ min: 0,
109
+ required: false,
110
+ },
111
+ down_payment_value: {
112
+ type: Number,
113
+ min: 0,
114
+ required: false,
115
+ },
116
+ payments: {
117
+ type: [Schema.Types.Mixed],
118
+ default: [],
119
+ },
120
+ gst: {
121
+ type: Number,
122
+ min: 0,
123
+ required: false,
124
+ },
125
+ gst_amount: {
126
+ type: Number,
127
+ min: 0,
128
+ required: false,
129
+ },
130
+ is_gst_inclusive: {
131
+ type: Boolean,
132
+ required: false,
133
+ },
134
+ created_by: {
135
+ type: WarehouseSaleOrderInvoiceActorSchema,
136
+ required: false,
137
+ },
138
+ posted_by: {
139
+ type: WarehouseSaleOrderInvoiceActorSchema,
140
+ required: false,
141
+ },
142
+ confirmed_by: {
143
+ type: WarehouseSaleOrderInvoiceActorSchema,
144
+ required: false,
145
+ },
146
+ refund_pending_by: {
147
+ type: WarehouseSaleOrderInvoiceActorSchema,
148
+ required: false,
149
+ },
150
+ refunded_by: {
151
+ type: WarehouseSaleOrderInvoiceActorSchema,
152
+ required: false,
153
+ },
154
+ cancelled_by: {
155
+ type: WarehouseSaleOrderInvoiceActorSchema,
156
+ required: false,
157
+ },
158
+ posted_at: {
159
+ type: Schema.Types.Date,
160
+ required: false,
161
+ },
162
+ confirmed_at: {
163
+ type: Schema.Types.Date,
164
+ required: false,
165
+ },
166
+ refund_pending_at: {
167
+ type: Schema.Types.Date,
168
+ required: false,
169
+ },
170
+ refunded_at: {
171
+ type: Schema.Types.Date,
172
+ required: false,
173
+ },
174
+ cancelled_at: {
175
+ type: Schema.Types.Date,
176
+ required: false,
177
+ },
178
+ cancel_reason: {
179
+ type: String,
180
+ required: false,
181
+ },
182
+ createdAt_mins: {
183
+ type: Number,
184
+ required: true,
185
+ immutable: true,
186
+ default: () => {
187
+ const date = new Date();
188
+ return Math.floor(date.getHours() * 60 + date.getMinutes());
189
+ },
190
+ },
191
+ createdAt: {
192
+ type: Schema.Types.Date,
193
+ required: true,
194
+ default: () => new Date(),
195
+ immutable: true,
196
+ },
197
+ updatedAt: {
198
+ type: Schema.Types.Date,
199
+ required: true,
200
+ default: () => new Date(),
201
+ },
202
+ }, {
203
+ timestamps: true,
204
+ versionKey: false,
205
+ minimize: false,
206
+ });
207
+ /**
208
+ * Describes the indexes for `warehouse_sale_invoices`. Values are Mongo key
209
+ * patterns that can be passed straight to `.hint()`.
210
+ * - `_id`: unique primary key.
211
+ * - `warehouse_id__sale_order_id__doc_kind__status`: invoice lookups by sale
212
+ * order, scoped by doc kind and status.
213
+ * - `warehouse_id__doc_kind__doc_number`: invoice lookups by doc kind and doc
214
+ * number.
215
+ */
216
+ export const WAREHOUSE_SALE_INVOICE_COLLECTION_INDEXES = {
217
+ _id: { _id: 1 }, // Unique Index
218
+ warehouse_id__sale_order_id__doc_kind__status: {
219
+ warehouse_id: 1,
220
+ sale_order_id: 1,
221
+ doc_kind: 1,
222
+ status: 1,
223
+ }, // invoice lookups by sale order, scoped by doc kind and status
224
+ warehouse_id__doc_kind__doc_number: {
225
+ warehouse_id: 1,
226
+ doc_kind: 1,
227
+ doc_number: 1,
228
+ }, // invoice lookups by doc kind and doc number
229
+ };