@managesome/eposmatic-toolkit 0.2.431 → 0.2.433

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 (172) hide show
  1. package/lib/constants/ENUMS.d.ts +0 -289
  2. package/lib/constants/ENUMS.js +2 -393
  3. package/lib/constants/PURCHASE_ORDER.d.ts +5 -3
  4. package/lib/constants/PURCHASE_ORDER.js +58 -20
  5. package/lib/constants/WAREHOUSE_ANALYTICS.d.ts +41 -41
  6. package/lib/constants/WAREHOUSE_ANALYTICS.js +28 -28
  7. package/lib/constants/WAREHOUSE_ENUMS.d.ts +289 -0
  8. package/lib/constants/WAREHOUSE_ENUMS.js +392 -0
  9. package/lib/constants/WAREHOUSE_INVOICE.js +10 -10
  10. package/lib/constants/WORKER_ENDPOINTS.d.ts +63 -0
  11. package/lib/constants/WORKER_ENDPOINTS.js +76 -0
  12. package/lib/constants/index.d.ts +2 -0
  13. package/lib/constants/index.js +2 -0
  14. package/lib/helpers/order/generate-purchase-order-rfq.d.ts +3 -3
  15. package/lib/helpers/order/generate-purchase-order-rfq.js +2 -2
  16. package/lib/helpers/order/generate-purchase-order.d.ts +8 -8
  17. package/lib/helpers/order/generate-purchase-order.js +2 -2
  18. package/lib/helpers/order/generate-warehouse-purchase-order-rfq.d.ts +3 -0
  19. package/lib/helpers/order/generate-warehouse-purchase-order-rfq.js +64 -0
  20. package/lib/helpers/order/generate-warehouse-purchase-order.d.ts +11 -0
  21. package/lib/helpers/order/generate-warehouse-purchase-order.js +196 -0
  22. package/lib/helpers/order/index.d.ts +2 -2
  23. package/lib/helpers/order/index.js +2 -2
  24. package/lib/helpers/store/all-purchase-orders-actions.d.ts +7 -7
  25. package/lib/helpers/store/all-purchase-orders-actions.js +2 -2
  26. package/lib/helpers/store/all-sale-orders-actions.d.ts +2 -2
  27. package/lib/helpers/store/all-warehouse-purchase-orders-actions.d.ts +13 -0
  28. package/lib/helpers/store/all-warehouse-purchase-orders-actions.js +56 -0
  29. package/lib/helpers/store/all-warehouse-sale-orders-actions.d.ts +2 -0
  30. package/lib/helpers/store/all-warehouse-sale-orders-actions.js +8 -0
  31. package/lib/helpers/store/common-purchase-order-actions.d.ts +15 -15
  32. package/lib/helpers/store/common-sale-order-actions.d.ts +5 -5
  33. package/lib/helpers/store/common-warehouse-purchase-order-actions.d.ts +31 -0
  34. package/lib/helpers/store/common-warehouse-purchase-order-actions.js +545 -0
  35. package/lib/helpers/store/common-warehouse-sale-order-actions.d.ts +5 -0
  36. package/lib/helpers/store/common-warehouse-sale-order-actions.js +65 -0
  37. package/lib/helpers/store/index.d.ts +6 -6
  38. package/lib/helpers/store/index.js +6 -6
  39. package/lib/helpers/store/purchase-order-rfq-cart-actions.d.ts +11 -11
  40. package/lib/helpers/store/purchase-order-rfq-cart-actions.js +3 -3
  41. package/lib/helpers/store/purchase-orders-cart-actions.d.ts +18 -18
  42. package/lib/helpers/store/purchase-orders-cart-actions.js +1 -1
  43. package/lib/helpers/store/warehouse-purchase-order-rfq-cart-actions.d.ts +19 -0
  44. package/lib/helpers/store/warehouse-purchase-order-rfq-cart-actions.js +373 -0
  45. package/lib/helpers/store/warehouse-purchase-orders-cart-actions.d.ts +57 -0
  46. package/lib/helpers/store/warehouse-purchase-orders-cart-actions.js +486 -0
  47. package/lib/helpers/types/index.d.ts +1 -1
  48. package/lib/helpers/types/index.js +1 -1
  49. package/lib/helpers/types/purchase-order-cart-actions.d.ts +2 -2
  50. package/lib/helpers/types/warehouse-purchase-order-cart-actions.d.ts +26 -0
  51. package/lib/helpers/types/warehouse-purchase-order-cart-actions.js +2 -0
  52. package/lib/helpers/types/workers.d.ts +39 -32
  53. package/lib/helpers/utils/index.d.ts +8 -8
  54. package/lib/helpers/utils/index.js +8 -11
  55. package/lib/helpers/utils/invoice-x-report-helpers.d.ts +2 -2
  56. package/lib/helpers/utils/invoice-x-report-helpers.js +14 -14
  57. package/lib/helpers/utils/purchase-order-engine.d.ts +4 -4
  58. package/lib/helpers/utils/purchase-order-receipt-engine.d.ts +5 -5
  59. package/lib/helpers/utils/purchase-order-receipt-engine.js +2 -2
  60. package/lib/helpers/utils/purchase-order-x-report-helpers.js +2 -2
  61. package/lib/helpers/utils/sale-x-report-helpers.js +2 -2
  62. package/lib/helpers/utils/void-purchase-order-items-helpers.d.ts +3 -3
  63. package/lib/helpers/utils/void-purchase-order-items-report-helpers.d.ts +2 -2
  64. package/lib/helpers/utils/void-warehouse-invoice-items-helpers.d.ts +3 -3
  65. package/lib/helpers/utils/void-warehouse-invoice-items-helpers.js +2 -2
  66. package/lib/helpers/utils/void-warehouse-invoice-items-report-helpers.d.ts +5 -5
  67. package/lib/helpers/utils/warehouse-catalog-conversion.d.ts +3 -3
  68. package/lib/helpers/utils/warehouse-catalog-conversion.js +9 -7
  69. package/lib/helpers/utils/warehouse-invoice-order-engine.js +1 -1
  70. package/lib/helpers/utils/warehouse-invoice-x-report-helpers.d.ts +58 -0
  71. package/lib/helpers/utils/warehouse-invoice-x-report-helpers.js +1432 -0
  72. package/lib/helpers/utils/warehouse-purchase-order-engine.d.ts +9 -0
  73. package/lib/helpers/utils/warehouse-purchase-order-engine.js +34 -0
  74. package/lib/helpers/utils/warehouse-purchase-order-receipt-engine.d.ts +149 -0
  75. package/lib/helpers/utils/warehouse-purchase-order-receipt-engine.js +214 -0
  76. package/lib/helpers/utils/warehouse-purchase-order-x-report-helpers.d.ts +58 -0
  77. package/lib/helpers/utils/warehouse-purchase-order-x-report-helpers.js +1440 -0
  78. package/lib/helpers/utils/warehouse-sale-order-x-report-helpers.d.ts +30 -0
  79. package/lib/helpers/utils/warehouse-sale-order-x-report-helpers.js +2 -0
  80. package/lib/helpers/utils/warehouse-sale-x-report-helpers.d.ts +58 -0
  81. package/lib/helpers/utils/warehouse-sale-x-report-helpers.js +1456 -0
  82. package/lib/helpers/utils/warehouse-void-purchase-order-items-helpers.d.ts +3 -0
  83. package/lib/helpers/utils/warehouse-void-purchase-order-items-helpers.js +38 -0
  84. package/lib/helpers/utils/warehouse-void-purchase-order-items-report-helpers.d.ts +13 -0
  85. package/lib/helpers/utils/warehouse-void-purchase-order-items-report-helpers.js +22 -0
  86. package/lib/schemas/models/gift_cards.d.ts +108 -108
  87. package/lib/schemas/models/halfhalf_setup.d.ts +3 -3
  88. package/lib/schemas/models/index.d.ts +7 -7
  89. package/lib/schemas/models/index.js +7 -7
  90. package/lib/schemas/models/internal_invoices.d.ts +6 -6
  91. package/lib/schemas/models/inventory_lot_serial_numbers.d.ts +6 -6
  92. package/lib/schemas/models/inventory_transactions.d.ts +3 -3
  93. package/lib/schemas/models/item_transactions.d.ts +6 -6
  94. package/lib/schemas/models/offers.d.ts +146 -146
  95. package/lib/schemas/models/orders.d.ts +2573 -2573
  96. package/lib/schemas/models/printer_settings.d.ts +12 -12
  97. package/lib/schemas/models/reservations.d.ts +6 -6
  98. package/lib/schemas/models/rewards_usage.d.ts +6 -6
  99. package/lib/schemas/models/riders.d.ts +3 -3
  100. package/lib/schemas/models/tenants.d.ts +135 -135
  101. package/lib/schemas/models/void_order_items.d.ts +15 -15
  102. package/lib/schemas/models/void_warehouse_invoice_items.d.ts +25 -25
  103. package/lib/schemas/models/void_warehouse_invoice_items.js +2 -2
  104. package/lib/schemas/models/vouchers.d.ts +9 -9
  105. package/lib/schemas/models/warehouse-activity-logs.d.ts +13 -13
  106. package/lib/schemas/models/warehouse-activity-logs.js +4 -4
  107. package/lib/schemas/models/warehouse_categories.d.ts +4 -4
  108. package/lib/schemas/models/warehouse_categories.js +2 -2
  109. package/lib/schemas/models/warehouse_communications.d.ts +21 -21
  110. package/lib/schemas/models/warehouse_internal_movements.d.ts +33 -33
  111. package/lib/schemas/models/warehouse_internal_movements.js +8 -8
  112. package/lib/schemas/models/warehouse_inventory_lot_serial_numbers.d.ts +154 -0
  113. package/lib/schemas/models/warehouse_inventory_lot_serial_numbers.js +193 -0
  114. package/lib/schemas/models/warehouse_inventory_transactions.d.ts +6 -6
  115. package/lib/schemas/models/warehouse_invoices.d.ts +351 -351
  116. package/lib/schemas/models/warehouse_item_transactions.d.ts +9 -9
  117. package/lib/schemas/models/warehouse_items.d.ts +13 -13
  118. package/lib/schemas/models/warehouse_items.js +2 -2
  119. package/lib/schemas/models/warehouse_operational_roles.d.ts +3 -3
  120. package/lib/schemas/models/warehouse_purchase_order_receipts.d.ts +165 -0
  121. package/lib/schemas/models/warehouse_purchase_order_receipts.js +151 -0
  122. package/lib/schemas/models/warehouse_purchase_order_rfqs.d.ts +1959 -0
  123. package/lib/schemas/models/warehouse_purchase_order_rfqs.js +328 -0
  124. package/lib/schemas/models/warehouse_purchase_order_vendor_returns.d.ts +234 -0
  125. package/lib/schemas/models/warehouse_purchase_order_vendor_returns.js +188 -0
  126. package/lib/schemas/models/warehouse_purchase_orders.d.ts +2678 -0
  127. package/lib/schemas/models/warehouse_purchase_orders.js +336 -0
  128. package/lib/schemas/models/warehouse_sale_deliveries.d.ts +15 -15
  129. package/lib/schemas/models/warehouse_sale_deliveries.js +7 -4
  130. package/lib/schemas/models/warehouse_sale_invoices.d.ts +30 -30
  131. package/lib/schemas/models/warehouse_sale_invoices.js +8 -5
  132. package/lib/schemas/models/warehouse_sale_order_rfqs.d.ts +362 -362
  133. package/lib/schemas/models/warehouse_sale_order_rfqs.js +5 -5
  134. package/lib/schemas/models/warehouse_sale_orders.d.ts +367 -367
  135. package/lib/schemas/models/warehouse_sale_orders.js +5 -5
  136. package/lib/schemas/models/warehouse_void_invoice_items.d.ts +176 -0
  137. package/lib/schemas/models/warehouse_void_invoice_items.js +176 -0
  138. package/lib/schemas/models/warehouse_void_purchase_order_items.d.ts +176 -0
  139. package/lib/schemas/models/warehouse_void_purchase_order_items.js +177 -0
  140. package/lib/schemas/models/warehouses.d.ts +52 -52
  141. package/lib/schemas/models/warehouses.js +2 -2
  142. package/lib/schemas/types/index.d.ts +9 -9
  143. package/lib/schemas/types/index.js +9 -9
  144. package/lib/schemas/types/inventory_lot_serial_numbers.d.ts +5 -5
  145. package/lib/schemas/types/warehouse-activity-logs.d.ts +7 -7
  146. package/lib/schemas/types/warehouse_categories.d.ts +2 -2
  147. package/lib/schemas/types/warehouse_internal_movements.d.ts +9 -9
  148. package/lib/schemas/types/warehouse_inventory_lot_serial_numbers.d.ts +85 -0
  149. package/lib/schemas/types/warehouse_inventory_lot_serial_numbers.js +4 -0
  150. package/lib/schemas/types/warehouse_items.d.ts +2 -2
  151. package/lib/schemas/types/warehouse_purchase_order_common.d.ts +39 -0
  152. package/lib/schemas/types/warehouse_purchase_order_common.js +2 -0
  153. package/lib/schemas/types/warehouse_purchase_order_receipts.d.ts +39 -0
  154. package/lib/schemas/types/warehouse_purchase_order_receipts.js +21 -0
  155. package/lib/schemas/types/warehouse_purchase_order_rfqs.d.ts +33 -0
  156. package/lib/schemas/types/warehouse_purchase_order_rfqs.js +2 -0
  157. package/lib/schemas/types/warehouse_purchase_order_vendor_returns.d.ts +48 -0
  158. package/lib/schemas/types/warehouse_purchase_order_vendor_returns.js +2 -0
  159. package/lib/schemas/types/warehouse_purchase_orders.d.ts +33 -0
  160. package/lib/schemas/types/warehouse_purchase_orders.js +2 -0
  161. package/lib/schemas/types/warehouse_sale_deliveries.d.ts +29 -29
  162. package/lib/schemas/types/warehouse_sale_invoices.d.ts +17 -17
  163. package/lib/schemas/types/warehouse_sale_order_common.d.ts +39 -0
  164. package/lib/schemas/types/warehouse_sale_order_common.js +2 -0
  165. package/lib/schemas/types/warehouse_sale_order_rfqs.d.ts +7 -7
  166. package/lib/schemas/types/warehouse_sale_orders.d.ts +7 -7
  167. package/lib/schemas/types/warehouse_void_invoice_items.d.ts +37 -0
  168. package/lib/schemas/types/warehouse_void_invoice_items.js +2 -0
  169. package/lib/schemas/types/warehouse_void_purchase_order_items.d.ts +37 -0
  170. package/lib/schemas/types/warehouse_void_purchase_order_items.js +2 -0
  171. package/lib/schemas/types/warehouses.d.ts +2 -2
  172. package/package.json +1 -1
@@ -0,0 +1,9 @@
1
+ import { IWarehousePurchaseOrderItem, IWarehouseItem } from '../../schemas';
2
+ interface IConvertWarehouseItemToPurchaseOrderItemParams {
3
+ vendorId: string;
4
+ item: IWarehouseItem;
5
+ orderItem?: IWarehousePurchaseOrderItem;
6
+ }
7
+ export declare function convertWarehouseItemToPurchaseOrderItem({ vendorId, item, orderItem, }: IConvertWarehouseItemToPurchaseOrderItemParams): IWarehousePurchaseOrderItem;
8
+ export declare function getCurrentWarehousePurchaseOrderItemTotalPrice(orderItem: IWarehousePurchaseOrderItem): number;
9
+ export {};
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.convertWarehouseItemToPurchaseOrderItem = convertWarehouseItemToPurchaseOrderItem;
7
+ exports.getCurrentWarehousePurchaseOrderItemTotalPrice = getCurrentWarehousePurchaseOrderItemTotalPrice;
8
+ const bson_objectid_1 = __importDefault(require("bson-objectid"));
9
+ function convertWarehouseItemToPurchaseOrderItem({ vendorId, item, orderItem, }) {
10
+ const { _id = (0, bson_objectid_1.default)().toHexString(), price = item.purchase_price?.[vendorId] ?? item.purchase_price?.BASE_PRICE ?? 0, quantity = 1, special_instructions = '', is_ready, } = orderItem ?? {};
11
+ const purchaseOrderItem = {
12
+ _id,
13
+ item_id: item._id,
14
+ name: item.name,
15
+ price,
16
+ subtotal: price * quantity,
17
+ quantity,
18
+ special_instructions,
19
+ is_ready,
20
+ // These values will be auto calculated
21
+ _discount_amount: 0,
22
+ _gross_amount: 0,
23
+ _gst_amount: 0,
24
+ _net_amount: 0,
25
+ };
26
+ return purchaseOrderItem;
27
+ }
28
+ // ==========================================================><====================================================
29
+ function getCurrentWarehousePurchaseOrderItemTotalPrice(orderItem) {
30
+ // For purchase orders, total is simply price * quantity
31
+ // No modifiers, discounts, etc.
32
+ const total = orderItem.price * orderItem.quantity;
33
+ return total;
34
+ }
@@ -0,0 +1,149 @@
1
+ import { CURRENCY_SYMBOL_ENUM } from '../../constants';
2
+ import { IWarehousePurchaseOrder, IWarehousePurchaseOrderItem, IWarehouse } from '../../schemas';
3
+ export interface IWarehouseReceiptProps {
4
+ order: Partial<IWarehousePurchaseOrder>;
5
+ warehouse_settings: {
6
+ image_url: IWarehouse['image_url'] | undefined;
7
+ name: IWarehouse['name'] | undefined;
8
+ warehouse_address: IWarehouse['warehouse_address'] | undefined;
9
+ support_email: IWarehouse['support_email'] | undefined;
10
+ public_phone_numbers: IWarehouse['public_phone_numbers'] | undefined;
11
+ currency_symbol: IWarehouse['currency_symbol'] | undefined;
12
+ tax_business_number: IWarehouse['tax_business_number'] | undefined;
13
+ tax_invoice_provider: IWarehouse['tax_invoice_provider'] | undefined;
14
+ hide_gst_value: IWarehouse['hide_gst_value'] | undefined;
15
+ country_alpha_2: IWarehouse['country_alpha_2'] | undefined;
16
+ };
17
+ printer_settings: {
18
+ display_item_instructions: boolean;
19
+ display_order_instructions: boolean;
20
+ display_unit_item_price: boolean;
21
+ print_staff_name: boolean;
22
+ };
23
+ }
24
+ export interface IWarehouseReceiptItem {
25
+ left: string;
26
+ right?: string;
27
+ prev_right?: string;
28
+ option_name?: string;
29
+ is_bold?: boolean;
30
+ _id?: string;
31
+ item_id?: string;
32
+ image_url?: string;
33
+ }
34
+ export interface IWarehouseReceiptEngine {
35
+ _id: string;
36
+ warehouse_details: {
37
+ image_url: IWarehouse['image_url'] | undefined;
38
+ name: IWarehouse['name'] | undefined;
39
+ warehouse_address: IWarehouse['warehouse_address'] | undefined;
40
+ support_email: IWarehouse['support_email'] | undefined;
41
+ public_phone_numbers: IWarehouse['public_phone_numbers'] | undefined;
42
+ taxNumberTitle: string;
43
+ tax_business_number: IWarehouse['tax_business_number'] | undefined;
44
+ };
45
+ placed_time: string;
46
+ expected_time: string | null;
47
+ order_number: string;
48
+ vendor_details: {
49
+ vendor_id?: string;
50
+ vendor_name?: string;
51
+ };
52
+ order_details: {
53
+ staff_name: string | null;
54
+ };
55
+ items: IWarehouseReceiptItem[];
56
+ footer: IWarehouseReceiptItem[];
57
+ total_items: number;
58
+ payment_details: IWarehouseReceiptItem[];
59
+ payment_status: string | null;
60
+ order_link: string | null;
61
+ cancel_reason: string | null;
62
+ }
63
+ export interface IWarehouseReceiptProps {
64
+ order: Partial<IWarehousePurchaseOrder>;
65
+ warehouse_settings: {
66
+ image_url: IWarehouse['image_url'] | undefined;
67
+ name: IWarehouse['name'] | undefined;
68
+ warehouse_address: IWarehouse['warehouse_address'] | undefined;
69
+ support_email: IWarehouse['support_email'] | undefined;
70
+ public_phone_numbers: IWarehouse['public_phone_numbers'] | undefined;
71
+ currency_symbol: IWarehouse['currency_symbol'] | undefined;
72
+ tax_business_number: IWarehouse['tax_business_number'] | undefined;
73
+ tax_invoice_provider: IWarehouse['tax_invoice_provider'] | undefined;
74
+ hide_gst_value: IWarehouse['hide_gst_value'] | undefined;
75
+ country_alpha_2: IWarehouse['country_alpha_2'] | undefined;
76
+ };
77
+ printer_settings: {
78
+ display_item_instructions: boolean;
79
+ display_order_instructions: boolean;
80
+ display_unit_item_price: boolean;
81
+ print_staff_name: boolean;
82
+ };
83
+ }
84
+ export interface IWarehouseReceiptItem {
85
+ left: string;
86
+ right?: string;
87
+ prev_right?: string;
88
+ option_name?: string;
89
+ is_bold?: boolean;
90
+ _id?: string;
91
+ item_id?: string;
92
+ image_url?: string;
93
+ }
94
+ export interface IWarehouseReceiptEngine {
95
+ _id: string;
96
+ warehouse_details: {
97
+ image_url: IWarehouse['image_url'] | undefined;
98
+ name: IWarehouse['name'] | undefined;
99
+ warehouse_address: IWarehouse['warehouse_address'] | undefined;
100
+ support_email: IWarehouse['support_email'] | undefined;
101
+ public_phone_numbers: IWarehouse['public_phone_numbers'] | undefined;
102
+ taxNumberTitle: string;
103
+ tax_business_number: IWarehouse['tax_business_number'] | undefined;
104
+ };
105
+ placed_time: string;
106
+ expected_time: string | null;
107
+ order_number: string;
108
+ vendor_details: {
109
+ vendor_id?: string;
110
+ vendor_name?: string;
111
+ };
112
+ order_details: {
113
+ staff_name: string | null;
114
+ };
115
+ items: IWarehouseReceiptItem[];
116
+ footer: IWarehouseReceiptItem[];
117
+ total_items: number;
118
+ payment_details: IWarehouseReceiptItem[];
119
+ payment_status: string | null;
120
+ order_link: string | null;
121
+ cancel_reason: string | null;
122
+ }
123
+ interface IWarehouseSettings {
124
+ currency_symbol: IWarehouse['currency_symbol'] | null | undefined;
125
+ gstName: string;
126
+ hide_gst_value: boolean | undefined;
127
+ }
128
+ export declare function getWarehouseReceiptEngineFooterDetails(order: Partial<IWarehousePurchaseOrder>, settings: IWarehouseSettings): IWarehouseReceiptItem[];
129
+ interface IWarehouseReceiptOrderItem extends IWarehousePurchaseOrderItem {
130
+ image_url?: string;
131
+ }
132
+ interface IGetWarehouseOrderItemReceiptBody {
133
+ orderItem: IWarehouseReceiptOrderItem;
134
+ currency_symbol?: string;
135
+ displayItemInstructions?: boolean;
136
+ displayUnitItemPrice?: boolean;
137
+ isRemoved?: boolean;
138
+ }
139
+ export declare function getWarehouseOrderItemReceiptBody({ orderItem, currency_symbol, displayItemInstructions, displayUnitItemPrice, isRemoved, }: IGetWarehouseOrderItemReceiptBody): IWarehouseReceiptItem[];
140
+ interface IGetWarehouseReceiptBody {
141
+ orderItems: IWarehouseReceiptOrderItem[];
142
+ currency_symbol: CURRENCY_SYMBOL_ENUM | null | undefined;
143
+ displayItemInstructions: boolean;
144
+ displayUnitItemPrice?: boolean;
145
+ isRemoved?: boolean;
146
+ }
147
+ export declare function getWarehouseReceiptBody({ orderItems, currency_symbol, displayItemInstructions, displayUnitItemPrice, isRemoved, }: IGetWarehouseReceiptBody): IWarehouseReceiptItem[];
148
+ export declare function getWarehouseReceiptEngine(payload: IWarehouseReceiptProps): IWarehouseReceiptEngine;
149
+ export {};
@@ -0,0 +1,214 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.getWarehouseReceiptEngineFooterDetails = getWarehouseReceiptEngineFooterDetails;
7
+ exports.getWarehouseOrderItemReceiptBody = getWarehouseOrderItemReceiptBody;
8
+ exports.getWarehouseReceiptBody = getWarehouseReceiptBody;
9
+ exports.getWarehouseReceiptEngine = getWarehouseReceiptEngine;
10
+ const emoji_strip_1 = __importDefault(require("emoji-strip"));
11
+ const moment_1 = __importDefault(require("moment"));
12
+ const constants_1 = require("../../constants");
13
+ const common_1 = require("./common");
14
+ const payment_helpers_1 = require("./payment-helpers");
15
+ // =========================><=========================
16
+ function getWarehouseReceiptEngineFooterDetails(order, settings) {
17
+ const currencySymbol = settings.currency_symbol ?? '';
18
+ const price = order.price ?? 0;
19
+ const grandTotal = order.grand_total ?? 0;
20
+ const details = [];
21
+ if (price !== grandTotal) {
22
+ const right = `${(0, common_1.localeAmount)(currencySymbol, price)}`;
23
+ details.push({
24
+ left: 'Price',
25
+ right,
26
+ });
27
+ }
28
+ if (order.gst && !settings.hide_gst_value) {
29
+ if (order.is_gst_inclusive) {
30
+ const right = (0, common_1.localeAmount)(currencySymbol, Math.max(0, (order.grand_total ?? 0) - (order.gst_amount ?? 0)));
31
+ details.push({
32
+ left: `Total before ${settings.gstName}`,
33
+ right,
34
+ });
35
+ }
36
+ let left = '';
37
+ if (order.is_gst_inclusive) {
38
+ left = `${settings.gstName} (${(0, common_1.parseNum)(order.gst)}% Inclusive)`;
39
+ }
40
+ else {
41
+ left = `${settings.gstName} (${(0, common_1.parseNum)(order.gst)}%)`;
42
+ }
43
+ const right = (0, common_1.localeAmount)(currencySymbol, order.gst_amount ?? 0);
44
+ details.push({
45
+ left,
46
+ right,
47
+ });
48
+ }
49
+ return details;
50
+ }
51
+ function getWarehouseOrderItemReceiptBody({ orderItem, currency_symbol, displayItemInstructions, displayUnitItemPrice, isRemoved, }) {
52
+ const name = orderItem.name;
53
+ const quantity = orderItem.quantity;
54
+ const subtotal = (0, common_1.parseNum)(orderItem.subtotal);
55
+ let description = `${quantity}x ${name}`;
56
+ const amount = (0, common_1.localeAmount)(currency_symbol, subtotal);
57
+ if (displayUnitItemPrice) {
58
+ description += ` @\u200E${(0, common_1.parseNum)(subtotal / quantity)}`;
59
+ }
60
+ const options = [
61
+ {
62
+ left: description,
63
+ right: amount,
64
+ _id: orderItem._id,
65
+ item_id: orderItem.item_id,
66
+ image_url: orderItem.image_url,
67
+ },
68
+ ];
69
+ if (!isRemoved && displayItemInstructions && orderItem.special_instructions.length > 0) {
70
+ options.push({
71
+ left: `** Note: ${(0, emoji_strip_1.default)(orderItem.special_instructions)} **`,
72
+ is_bold: true,
73
+ });
74
+ }
75
+ if (isRemoved && orderItem.void_reason != null && orderItem.void_reason.length > 0) {
76
+ options.push({
77
+ left: `** Reason: ${(0, emoji_strip_1.default)(orderItem.void_reason)} **`,
78
+ is_bold: true,
79
+ });
80
+ }
81
+ return options;
82
+ }
83
+ function getWarehouseReceiptBody({ orderItems, currency_symbol, displayItemInstructions, displayUnitItemPrice, isRemoved, }) {
84
+ const currency = currency_symbol ?? '';
85
+ const items = orderItems
86
+ .map((item) => getWarehouseOrderItemReceiptBody({
87
+ orderItem: item,
88
+ currency_symbol: currency,
89
+ displayItemInstructions,
90
+ displayUnitItemPrice,
91
+ isRemoved,
92
+ }))
93
+ .flat();
94
+ return items;
95
+ }
96
+ // =========================><=========================
97
+ function getWarehouseReceiptEngine(payload) {
98
+ const { currency_symbol, image_url, name, public_phone_numbers, warehouse_address, support_email, tax_business_number, tax_invoice_provider, country_alpha_2, hide_gst_value, } = payload.warehouse_settings;
99
+ const { display_item_instructions, display_order_instructions, display_unit_item_price, print_staff_name } = payload.printer_settings;
100
+ const currencySymbol = currency_symbol ?? '';
101
+ const grandTotal = payload.order.grand_total ?? 0;
102
+ const { amountPayedSoFar, existingPayments, change } = (0, payment_helpers_1.getOrderPaymentsDetails)(payload.order.grand_total, payload.order.payments);
103
+ const payments = (0, payment_helpers_1.getSortedPayments)(existingPayments.filter((payment) => payment.payment_status === constants_1.PAYMENT_STATUS_ENUM.SETTLED ||
104
+ payment.payment_status === constants_1.PAYMENT_STATUS_ENUM.REFUNDED));
105
+ const gstName = (0, common_1.getGSTName)(country_alpha_2, tax_invoice_provider);
106
+ const taxNumberTitle = (0, common_1.getTaxNumberTitle)(country_alpha_2, tax_invoice_provider);
107
+ const isFullyPaid = (0, payment_helpers_1.isOrderFullyPaid)(grandTotal, payload.order.payments);
108
+ const settings = {
109
+ currency_symbol,
110
+ gstName,
111
+ hide_gst_value,
112
+ };
113
+ const categories = payload.order.categories ?? [];
114
+ const items = categories.reduce((acc, category) => acc.concat(category.items.map((item) => ({
115
+ ...item,
116
+ }))), []);
117
+ const receiptItems = getWarehouseReceiptBody({
118
+ orderItems: items,
119
+ currency_symbol,
120
+ displayItemInstructions: display_item_instructions,
121
+ displayUnitItemPrice: display_unit_item_price,
122
+ });
123
+ const total_items = items.length;
124
+ const changeAmount = change > 0 ? (0, common_1.localeAmount)(currencySymbol, change) : null;
125
+ const payment_details = [
126
+ ...payments.map((payment) => {
127
+ const isRefund = payment.amount_refunded > 0 && payment.amount_refunded > payment.amount_paid;
128
+ const paymentTitle = (0, payment_helpers_1.getPaymentSmartTitle)(payment.payment_type).title;
129
+ const amount = (payment.payment_type !== constants_1.PAYMENT_TYPE_ENUM.UNPAID
130
+ ? isRefund
131
+ ? payment.amount_refunded - payment.amount_paid
132
+ : payment.amount_paid
133
+ : payment.amount_due) + (payment.card_details?.card_charges ?? 0);
134
+ return {
135
+ left: `${(0, common_1.sentenceCase)(paymentTitle).replace(/_/g, ' ')}${isRefund ? ' (Refund)' : ''}`,
136
+ right: (0, common_1.localeAmount)(currencySymbol, amount),
137
+ };
138
+ }),
139
+ ...(changeAmount
140
+ ? [
141
+ {
142
+ left: 'Change',
143
+ right: changeAmount,
144
+ },
145
+ ]
146
+ : []),
147
+ ];
148
+ const parsedAmountPayedSoFar = (0, common_1.parseNum)(amountPayedSoFar);
149
+ const staff_name = print_staff_name && payload.order.staff_details != null ? (payload.order.staff_details.staff_name ?? null) : null;
150
+ let payment_status = null;
151
+ if (payload.order.is_deleted) {
152
+ payment_status = '* DELETED *';
153
+ }
154
+ else if (payload.order.order_status === constants_1.WAREHOUSE_PURCHASE_ORDER_STATUS_ENUM.CANCELLED) {
155
+ payment_status = '* CANCELLED *';
156
+ }
157
+ else {
158
+ if (parsedAmountPayedSoFar >= (0, common_1.parseNum)(grandTotal)) {
159
+ payment_status = '* PAID *';
160
+ }
161
+ else if (parsedAmountPayedSoFar > 0) {
162
+ payment_status = '* PARTIALLY PAID *';
163
+ payment_details.push({
164
+ left: 'Pending Amount',
165
+ right: (0, common_1.localeAmount)(currencySymbol, grandTotal - parsedAmountPayedSoFar),
166
+ });
167
+ }
168
+ else {
169
+ payment_status = '* UNPAID *';
170
+ }
171
+ }
172
+ let cancel_reason = null;
173
+ if (payload.order.order_status === constants_1.WAREHOUSE_PURCHASE_ORDER_STATUS_ENUM.CANCELLED) {
174
+ cancel_reason = payload.order.cancel_reason ?? null;
175
+ }
176
+ let invoice_name = `Invoice #${payload.order.order_number ?? ''}`;
177
+ if (isFullyPaid) {
178
+ if (payload.order.tax_number || (country_alpha_2 !== constants_1.COUNTRY_ALPHA_2_ENUM.PK && tax_business_number)) {
179
+ invoice_name = `Tax ${invoice_name}`;
180
+ }
181
+ }
182
+ const engine = {
183
+ _id: payload.order._id ?? '',
184
+ warehouse_details: {
185
+ image_url,
186
+ name,
187
+ warehouse_address,
188
+ support_email,
189
+ public_phone_numbers,
190
+ tax_business_number,
191
+ taxNumberTitle,
192
+ },
193
+ placed_time: (0, moment_1.default)(payload.order.createdAt).format('ddd, MMMM Do, h:mmA'),
194
+ expected_time: null,
195
+ order_number: invoice_name,
196
+ vendor_details: {
197
+ vendor_id: payload.order.vendor_id,
198
+ },
199
+ order_details: {
200
+ staff_name,
201
+ },
202
+ payment_status,
203
+ order_link: null,
204
+ total_items,
205
+ items: receiptItems,
206
+ payment_details,
207
+ footer: getWarehouseReceiptEngineFooterDetails(payload.order, settings).concat({
208
+ left: `Grand Total${payload.order.gst && hide_gst_value ? ` (Incl. ${gstName})` : ''}`,
209
+ right: (0, common_1.localeAmount)(currencySymbol, payload.order.grand_total ?? 0),
210
+ }),
211
+ cancel_reason,
212
+ };
213
+ return engine;
214
+ }
@@ -0,0 +1,58 @@
1
+ import { COUNTRY_ALPHA_2_ENUM, CURRENCY_SYMBOL_ENUM, IWarehousePurchaseOrderXReport } from '../../constants';
2
+ interface IWarehouseFooterDetail {
3
+ amount: number;
4
+ count: number;
5
+ title: string;
6
+ sortIndex: number;
7
+ }
8
+ export interface IWarehouseUsablePurchaseOrderXReportSubChannel {
9
+ _id: string;
10
+ ref: string | number;
11
+ title: string;
12
+ count: number;
13
+ amount: number;
14
+ strikeThrough?: boolean;
15
+ bold?: boolean;
16
+ sortIndex: number;
17
+ }
18
+ export interface IWarehouseUsablePurchaseOrderXReportChannel {
19
+ _id: string;
20
+ ref: string;
21
+ title: string;
22
+ sortIndex: number;
23
+ footerDetails: IWarehouseFooterDetail[];
24
+ subChannels: IWarehouseUsablePurchaseOrderXReportSubChannel[];
25
+ }
26
+ export interface IWarehouseUsablePurchaseOrderXReportData {
27
+ _id: string;
28
+ title: string;
29
+ netSale: number;
30
+ netWithoutGst: number;
31
+ netWithoutGstSubtitle: string;
32
+ totalOrders: number;
33
+ unpaidOrders: number;
34
+ unpaidAmount: number;
35
+ amountCollected: number;
36
+ itemSales: number;
37
+ channels: IWarehouseUsablePurchaseOrderXReportChannel[];
38
+ }
39
+ export interface IWarehousePurchaseOrderXReportProps {
40
+ from: Date;
41
+ to: Date;
42
+ vendorWiseData: IWarehouseUsablePurchaseOrderXReportData[];
43
+ combinedData?: IWarehouseUsablePurchaseOrderXReportData;
44
+ currency_symbol: CURRENCY_SYMBOL_ENUM | undefined;
45
+ warehouseName: string | undefined;
46
+ isFilterApplied: boolean;
47
+ }
48
+ interface IWarehouseUsableData {
49
+ vendorWiseData: IWarehouseUsablePurchaseOrderXReportData[];
50
+ combinedData: IWarehouseUsablePurchaseOrderXReportData;
51
+ }
52
+ interface IWarehousePurchaseOrderXReportHtmlProps extends IWarehousePurchaseOrderXReportProps {
53
+ width?: number;
54
+ monochrome?: boolean;
55
+ }
56
+ export declare function getWarehousePurchaseOrderXReportHtml({ width, monochrome, vendorWiseData, combinedData, currency_symbol, from, to, warehouseName, isFilterApplied, }: IWarehousePurchaseOrderXReportHtmlProps): string;
57
+ export declare const getWarehousePurchaseOrderXReportData: (data: IWarehousePurchaseOrderXReport, currencySymbol: CURRENCY_SYMBOL_ENUM | undefined, countryAlpha2: COUNTRY_ALPHA_2_ENUM | undefined) => IWarehouseUsableData;
58
+ export {};