@managesome/eposmatic-toolkit 0.3.10 → 0.4.0

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 (145) hide show
  1. package/esm/constants/ENUMS.js +17 -1988
  2. package/esm/constants/MATERIALIZED_REPORTS.js +105 -0
  3. package/esm/constants/enums/cash.js +45 -0
  4. package/esm/constants/enums/communications.js +329 -0
  5. package/esm/constants/enums/delivery.js +35 -0
  6. package/esm/constants/enums/geo.js +150 -0
  7. package/esm/constants/enums/hr.js +130 -0
  8. package/esm/constants/enums/internal.js +132 -0
  9. package/esm/constants/enums/items.js +126 -0
  10. package/esm/constants/enums/misc.js +35 -0
  11. package/esm/constants/enums/offers.js +102 -0
  12. package/esm/constants/enums/order.js +135 -0
  13. package/esm/constants/enums/payments.js +186 -0
  14. package/esm/constants/enums/platform.js +215 -0
  15. package/esm/constants/enums/printing.js +107 -0
  16. package/esm/constants/enums/users.js +245 -0
  17. package/esm/constants/enums/wallet.js +32 -0
  18. package/esm/helpers/materialized-reports/index.js +5 -0
  19. package/esm/helpers/materialized-reports/key-helpers.js +59 -0
  20. package/esm/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.js +60 -0
  21. package/esm/helpers/materialized-reports/scope-helpers.js +107 -0
  22. package/esm/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +251 -0
  23. package/esm/helpers/materialized-reports/tenant-sales-overview-helpers.js +860 -0
  24. package/esm/helpers/store/cart-actions.js +1 -1
  25. package/esm/helpers/store/common-tenant-purchase-order-actions.js +7 -7
  26. package/esm/helpers/store/common-warehouse-purchase-order-actions.js +1 -1
  27. package/esm/helpers/store/common-warehouse-purchase-order-rfq-actions.js +1 -1
  28. package/esm/helpers/store/common-warehouse-sale-order-actions.js +1 -1
  29. package/esm/helpers/store/common-warehouse-sale-order-rfq-actions.js +1 -1
  30. package/esm/helpers/store/offline-ordering.js +1 -1
  31. package/esm/helpers/store/tenant-purchase-orders-cart-actions.js +1 -1
  32. package/esm/helpers/store/warehouse-purchase-order-rfq-cart-actions.js +1 -1
  33. package/esm/helpers/store/warehouse-purchase-orders-cart-actions.js +1 -1
  34. package/esm/helpers/store/warehouse-sale-order-rfq-cart-actions.js +1 -1
  35. package/esm/helpers/store/warehouse-sale-orders-cart-actions.js +1 -1
  36. package/esm/helpers/utils/cancellation-helpers.js +7 -0
  37. package/esm/helpers/utils/common.js +0 -46
  38. package/esm/helpers/utils/getFormFieldsDiff.js +1 -1
  39. package/esm/helpers/utils/index.js +2 -0
  40. package/esm/helpers/utils/phone-helpers.js +40 -0
  41. package/esm/helpers/utils/receipt-engine.js +3 -1
  42. package/esm/helpers/utils/specials-helpers.js +1 -1
  43. package/esm/helpers/utils/void-items-report-helpers.js +2 -1
  44. package/esm/schemas/models/materialized_tenant_reports_iterations.js +82 -0
  45. package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +399 -0
  46. package/esm/schemas/types/materialized_tenant_reports_iterations.js +1 -0
  47. package/esm/schemas/types/materialized_tenant_sales_overview_reports.js +1 -0
  48. package/lib/constants/ENUMS.d.ts +15 -1275
  49. package/lib/constants/ENUMS.js +31 -1994
  50. package/lib/constants/MATERIALIZED_REPORTS.d.ts +96 -0
  51. package/lib/constants/MATERIALIZED_REPORTS.js +108 -0
  52. package/lib/constants/enums/cash.d.ts +35 -0
  53. package/lib/constants/enums/cash.js +48 -0
  54. package/lib/constants/enums/communications.d.ts +79 -0
  55. package/lib/constants/enums/communications.js +332 -0
  56. package/lib/constants/enums/delivery.d.ts +26 -0
  57. package/lib/constants/enums/delivery.js +38 -0
  58. package/lib/constants/enums/geo.d.ts +133 -0
  59. package/lib/constants/enums/geo.js +153 -0
  60. package/lib/constants/enums/hr.d.ts +105 -0
  61. package/lib/constants/enums/hr.js +133 -0
  62. package/lib/constants/enums/internal.d.ts +104 -0
  63. package/lib/constants/enums/internal.js +135 -0
  64. package/lib/constants/enums/items.d.ts +94 -0
  65. package/lib/constants/enums/items.js +129 -0
  66. package/lib/constants/enums/misc.d.ts +25 -0
  67. package/lib/constants/enums/misc.js +38 -0
  68. package/lib/constants/enums/offers.d.ts +80 -0
  69. package/lib/constants/enums/offers.js +105 -0
  70. package/lib/constants/enums/order.d.ts +108 -0
  71. package/lib/constants/enums/order.js +138 -0
  72. package/lib/constants/enums/payments.d.ts +129 -0
  73. package/lib/constants/enums/payments.js +189 -0
  74. package/lib/constants/enums/platform.d.ts +100 -0
  75. package/lib/constants/enums/platform.js +218 -0
  76. package/lib/constants/enums/printing.d.ts +89 -0
  77. package/lib/constants/enums/printing.js +110 -0
  78. package/lib/constants/enums/users.d.ts +142 -0
  79. package/lib/constants/enums/users.js +248 -0
  80. package/lib/constants/enums/wallet.d.ts +26 -0
  81. package/lib/constants/enums/wallet.js +35 -0
  82. package/lib/helpers/materialized-reports/index.d.ts +5 -0
  83. package/lib/helpers/materialized-reports/index.js +21 -0
  84. package/lib/helpers/materialized-reports/key-helpers.d.ts +35 -0
  85. package/lib/helpers/materialized-reports/key-helpers.js +64 -0
  86. package/lib/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.d.ts +66 -0
  87. package/lib/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.js +63 -0
  88. package/lib/helpers/materialized-reports/scope-helpers.d.ts +57 -0
  89. package/lib/helpers/materialized-reports/scope-helpers.js +114 -0
  90. package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.d.ts +125 -0
  91. package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +256 -0
  92. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.d.ts +223 -0
  93. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.js +875 -0
  94. package/lib/helpers/store/cart-actions.js +6 -6
  95. package/lib/helpers/store/common-tenant-purchase-order-actions.d.ts +2 -2
  96. package/lib/helpers/store/common-tenant-purchase-order-actions.js +10 -10
  97. package/lib/helpers/store/common-warehouse-purchase-order-actions.js +4 -4
  98. package/lib/helpers/store/common-warehouse-purchase-order-rfq-actions.js +4 -4
  99. package/lib/helpers/store/common-warehouse-sale-order-actions.js +4 -4
  100. package/lib/helpers/store/common-warehouse-sale-order-rfq-actions.js +4 -4
  101. package/lib/helpers/store/offline-ordering.js +2 -2
  102. package/lib/helpers/store/tenant-purchase-orders-cart-actions.js +2 -2
  103. package/lib/helpers/store/warehouse-purchase-order-rfq-cart-actions.js +2 -2
  104. package/lib/helpers/store/warehouse-purchase-orders-cart-actions.js +2 -2
  105. package/lib/helpers/store/warehouse-sale-order-rfq-cart-actions.js +2 -2
  106. package/lib/helpers/store/warehouse-sale-orders-cart-actions.js +2 -2
  107. package/lib/helpers/utils/cancellation-helpers.d.ts +1 -0
  108. package/lib/helpers/utils/cancellation-helpers.js +13 -0
  109. package/lib/helpers/utils/common.d.ts +0 -6
  110. package/lib/helpers/utils/common.js +1 -54
  111. package/lib/helpers/utils/getFormFieldsDiff.js +5 -2
  112. package/lib/helpers/utils/index.d.ts +2 -0
  113. package/lib/helpers/utils/index.js +2 -0
  114. package/lib/helpers/utils/phone-helpers.d.ts +5 -0
  115. package/lib/helpers/utils/phone-helpers.js +46 -0
  116. package/lib/helpers/utils/receipt-engine.js +4 -2
  117. package/lib/helpers/utils/specials-helpers.js +2 -2
  118. package/lib/helpers/utils/void-items-report-helpers.js +3 -2
  119. package/lib/schemas/models/materialized_tenant_reports_iterations.d.ts +80 -0
  120. package/lib/schemas/models/materialized_tenant_reports_iterations.js +85 -0
  121. package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +569 -0
  122. package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +402 -0
  123. package/lib/schemas/types/materialized_tenant_reports_iterations.d.ts +62 -0
  124. package/lib/schemas/types/materialized_tenant_reports_iterations.js +2 -0
  125. package/lib/schemas/types/materialized_tenant_sales_overview_reports.d.ts +242 -0
  126. package/lib/schemas/types/materialized_tenant_sales_overview_reports.js +3 -0
  127. package/lib/tests/materialized-reports/fixtures.d.ts +81 -0
  128. package/lib/tests/materialized-reports/fixtures.js +87 -0
  129. package/lib/tests/materialized-reports/fixtures.test.d.ts +1 -0
  130. package/lib/tests/materialized-reports/fixtures.test.js +123 -0
  131. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-helpers.test.d.ts +1 -0
  132. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-helpers.test.js +75 -0
  133. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-schema.test.d.ts +1 -0
  134. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-schema.test.js +73 -0
  135. package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.d.ts +1 -0
  136. package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.js +207 -0
  137. package/lib/tests/materialized-reports/sales-overview-baseline.test.d.ts +1 -0
  138. package/lib/tests/materialized-reports/sales-overview-baseline.test.js +326 -0
  139. package/lib/tests/materialized-reports/sales-overview-reference.d.ts +63 -0
  140. package/lib/tests/materialized-reports/sales-overview-reference.js +131 -0
  141. package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.d.ts +1 -0
  142. package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.js +335 -0
  143. package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.d.ts +1 -0
  144. package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.js +885 -0
  145. package/package.json +5 -2
@@ -0,0 +1,569 @@
1
+ import { Schema } from 'mongoose';
2
+ /**
3
+ * Mongoose schema for `materialized_tenant_sales_overview_reports` — the
4
+ * materialized Reports > Overview data (one document per tenant × scope
5
+ * context × scope value), maintained by the day-end materialization job and
6
+ * read by the analytics API. Scope slices are stamped from the order's
7
+ * business day (`order.localDate`); hour buckets use the punch hour for sales
8
+ * and the settlement hour for credit-bill collections (see
9
+ * `MATERIALIZED_REPORTS.md`). The report's time-bias toggle (Punched At /
10
+ * `createdAt`) is out of scope. `scope_field` formats are documented on
11
+ * `MATERIALIZED_REPORT_SCOPE_ENUM` and in `MATERIALIZED_REPORTS.md`.
12
+ * Credit bills (`PAY_LATER`) live in each `sale_type_metrics` key's
13
+ * `CREDIT_BILLS` slot as a ledger (issued + settled tracking / received);
14
+ * gross stays sales-only and report views are derived by the frontend
15
+ * formatter. Iteration history (every structural write's full post-write
16
+ * snapshot) lives in the shared `materialized_tenant_reports_iterations` collection.
17
+ */
18
+ /**
19
+ * Version of the key grammar + metric rules of this collection. Bump when
20
+ * `sale_type_key_filters`, their order, or metric semantics change —
21
+ * historical documents must then be re-materialized (readers may branch on
22
+ * this value during a rollout).
23
+ */
24
+ export declare const MATERIALIZED_TENANT_SALES_OVERVIEW_REPORTS_SCHEMA_VERSION = 1;
25
+ export declare const MaterializedTenantSalesOverviewReportSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
26
+ timestamps: true;
27
+ versionKey: false;
28
+ minimize: false;
29
+ }, {
30
+ createdAt: NativeDate;
31
+ updatedAt: NativeDate;
32
+ } & {
33
+ _id: import("mongoose").Types.ObjectId;
34
+ tenant_id: string;
35
+ createdAt: NativeDate;
36
+ updatedAt: NativeDate;
37
+ brand_id: string;
38
+ day_index: import("../../constants").DAY_INDEX_ENUM;
39
+ iteration: number;
40
+ schema_version: number;
41
+ scope_context: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_SCOPE_ENUM;
42
+ scope_field: string;
43
+ sale_type_key_filters: string[];
44
+ sale_type_metrics: Map<string, {
45
+ TOTAL_SALES: {
46
+ orders: {
47
+ count: number;
48
+ discount_amount: number;
49
+ delivery_charges: number;
50
+ gst_amount: number;
51
+ tip_amount: number;
52
+ tax_amount: number;
53
+ tax_invoice_provider_charges: number;
54
+ gross_amount: number;
55
+ discount_by_type: {
56
+ special_discount: number;
57
+ loyalty_discount: number;
58
+ voucher_discount: number;
59
+ };
60
+ };
61
+ payments: import("mongoose").Types.DocumentArray<{
62
+ count: number;
63
+ card_charges: number;
64
+ payment_type: string;
65
+ amount_paid: number;
66
+ amount_due: number;
67
+ amount_refunded: number;
68
+ gross_amount: number;
69
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
70
+ count: number;
71
+ card_charges: number;
72
+ payment_type: string;
73
+ amount_paid: number;
74
+ amount_due: number;
75
+ amount_refunded: number;
76
+ gross_amount: number;
77
+ }> & {
78
+ count: number;
79
+ card_charges: number;
80
+ payment_type: string;
81
+ amount_paid: number;
82
+ amount_due: number;
83
+ amount_refunded: number;
84
+ gross_amount: number;
85
+ }>;
86
+ };
87
+ AMOUNT_COLLECTED: {
88
+ orders: {
89
+ count: number;
90
+ discount_amount: number;
91
+ delivery_charges: number;
92
+ gst_amount: number;
93
+ tip_amount: number;
94
+ tax_amount: number;
95
+ tax_invoice_provider_charges: number;
96
+ gross_amount: number;
97
+ discount_by_type: {
98
+ special_discount: number;
99
+ loyalty_discount: number;
100
+ voucher_discount: number;
101
+ };
102
+ };
103
+ payments: import("mongoose").Types.DocumentArray<{
104
+ count: number;
105
+ card_charges: number;
106
+ payment_type: string;
107
+ amount_paid: number;
108
+ amount_due: number;
109
+ amount_refunded: number;
110
+ gross_amount: number;
111
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
112
+ count: number;
113
+ card_charges: number;
114
+ payment_type: string;
115
+ amount_paid: number;
116
+ amount_due: number;
117
+ amount_refunded: number;
118
+ gross_amount: number;
119
+ }> & {
120
+ count: number;
121
+ card_charges: number;
122
+ payment_type: string;
123
+ amount_paid: number;
124
+ amount_due: number;
125
+ amount_refunded: number;
126
+ gross_amount: number;
127
+ }>;
128
+ };
129
+ CREDIT_BILLS: {
130
+ issued?: {
131
+ count: number;
132
+ amount: number;
133
+ settled_count: number;
134
+ settled_amount: number;
135
+ bills: import("mongoose").Types.DocumentArray<{
136
+ order_id: string;
137
+ payment_id: string;
138
+ amount: number;
139
+ received_amount: number;
140
+ credit_note: string;
141
+ issued_at: NativeDate;
142
+ settled_at: NativeDate;
143
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
144
+ order_id: string;
145
+ payment_id: string;
146
+ amount: number;
147
+ received_amount: number;
148
+ credit_note: string;
149
+ issued_at: NativeDate;
150
+ settled_at: NativeDate;
151
+ }> & {
152
+ order_id: string;
153
+ payment_id: string;
154
+ amount: number;
155
+ received_amount: number;
156
+ credit_note: string;
157
+ issued_at: NativeDate;
158
+ settled_at: NativeDate;
159
+ }>;
160
+ } | null | undefined;
161
+ received?: {
162
+ count: number;
163
+ amount: number;
164
+ bills: import("mongoose").Types.DocumentArray<{
165
+ order_id: string;
166
+ payment_id: string;
167
+ amount: number;
168
+ received_amount: number;
169
+ credit_note: string;
170
+ settled_at: NativeDate;
171
+ issued_local_date: string;
172
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
173
+ order_id: string;
174
+ payment_id: string;
175
+ amount: number;
176
+ received_amount: number;
177
+ credit_note: string;
178
+ settled_at: NativeDate;
179
+ issued_local_date: string;
180
+ }> & {
181
+ order_id: string;
182
+ payment_id: string;
183
+ amount: number;
184
+ received_amount: number;
185
+ credit_note: string;
186
+ settled_at: NativeDate;
187
+ issued_local_date: string;
188
+ }>;
189
+ } | null | undefined;
190
+ };
191
+ }>;
192
+ source_watermark: NativeDate;
193
+ computed_at: NativeDate;
194
+ }, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
195
+ createdAt: NativeDate;
196
+ updatedAt: NativeDate;
197
+ } & {
198
+ _id: import("mongoose").Types.ObjectId;
199
+ tenant_id: string;
200
+ createdAt: NativeDate;
201
+ updatedAt: NativeDate;
202
+ brand_id: string;
203
+ day_index: import("../../constants").DAY_INDEX_ENUM;
204
+ iteration: number;
205
+ schema_version: number;
206
+ scope_context: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_SCOPE_ENUM;
207
+ scope_field: string;
208
+ sale_type_key_filters: string[];
209
+ sale_type_metrics: Map<string, {
210
+ TOTAL_SALES: {
211
+ orders: {
212
+ count: number;
213
+ discount_amount: number;
214
+ delivery_charges: number;
215
+ gst_amount: number;
216
+ tip_amount: number;
217
+ tax_amount: number;
218
+ tax_invoice_provider_charges: number;
219
+ gross_amount: number;
220
+ discount_by_type: {
221
+ special_discount: number;
222
+ loyalty_discount: number;
223
+ voucher_discount: number;
224
+ };
225
+ };
226
+ payments: import("mongoose").Types.DocumentArray<{
227
+ count: number;
228
+ card_charges: number;
229
+ payment_type: string;
230
+ amount_paid: number;
231
+ amount_due: number;
232
+ amount_refunded: number;
233
+ gross_amount: number;
234
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
235
+ count: number;
236
+ card_charges: number;
237
+ payment_type: string;
238
+ amount_paid: number;
239
+ amount_due: number;
240
+ amount_refunded: number;
241
+ gross_amount: number;
242
+ }> & {
243
+ count: number;
244
+ card_charges: number;
245
+ payment_type: string;
246
+ amount_paid: number;
247
+ amount_due: number;
248
+ amount_refunded: number;
249
+ gross_amount: number;
250
+ }>;
251
+ };
252
+ AMOUNT_COLLECTED: {
253
+ orders: {
254
+ count: number;
255
+ discount_amount: number;
256
+ delivery_charges: number;
257
+ gst_amount: number;
258
+ tip_amount: number;
259
+ tax_amount: number;
260
+ tax_invoice_provider_charges: number;
261
+ gross_amount: number;
262
+ discount_by_type: {
263
+ special_discount: number;
264
+ loyalty_discount: number;
265
+ voucher_discount: number;
266
+ };
267
+ };
268
+ payments: import("mongoose").Types.DocumentArray<{
269
+ count: number;
270
+ card_charges: number;
271
+ payment_type: string;
272
+ amount_paid: number;
273
+ amount_due: number;
274
+ amount_refunded: number;
275
+ gross_amount: number;
276
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
277
+ count: number;
278
+ card_charges: number;
279
+ payment_type: string;
280
+ amount_paid: number;
281
+ amount_due: number;
282
+ amount_refunded: number;
283
+ gross_amount: number;
284
+ }> & {
285
+ count: number;
286
+ card_charges: number;
287
+ payment_type: string;
288
+ amount_paid: number;
289
+ amount_due: number;
290
+ amount_refunded: number;
291
+ gross_amount: number;
292
+ }>;
293
+ };
294
+ CREDIT_BILLS: {
295
+ issued?: {
296
+ count: number;
297
+ amount: number;
298
+ settled_count: number;
299
+ settled_amount: number;
300
+ bills: import("mongoose").Types.DocumentArray<{
301
+ order_id: string;
302
+ payment_id: string;
303
+ amount: number;
304
+ received_amount: number;
305
+ credit_note: string;
306
+ issued_at: NativeDate;
307
+ settled_at: NativeDate;
308
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
309
+ order_id: string;
310
+ payment_id: string;
311
+ amount: number;
312
+ received_amount: number;
313
+ credit_note: string;
314
+ issued_at: NativeDate;
315
+ settled_at: NativeDate;
316
+ }> & {
317
+ order_id: string;
318
+ payment_id: string;
319
+ amount: number;
320
+ received_amount: number;
321
+ credit_note: string;
322
+ issued_at: NativeDate;
323
+ settled_at: NativeDate;
324
+ }>;
325
+ } | null | undefined;
326
+ received?: {
327
+ count: number;
328
+ amount: number;
329
+ bills: import("mongoose").Types.DocumentArray<{
330
+ order_id: string;
331
+ payment_id: string;
332
+ amount: number;
333
+ received_amount: number;
334
+ credit_note: string;
335
+ settled_at: NativeDate;
336
+ issued_local_date: string;
337
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
338
+ order_id: string;
339
+ payment_id: string;
340
+ amount: number;
341
+ received_amount: number;
342
+ credit_note: string;
343
+ settled_at: NativeDate;
344
+ issued_local_date: string;
345
+ }> & {
346
+ order_id: string;
347
+ payment_id: string;
348
+ amount: number;
349
+ received_amount: number;
350
+ credit_note: string;
351
+ settled_at: NativeDate;
352
+ issued_local_date: string;
353
+ }>;
354
+ } | null | undefined;
355
+ };
356
+ }>;
357
+ source_watermark: NativeDate;
358
+ computed_at: NativeDate;
359
+ }>> & import("mongoose").FlatRecord<{
360
+ createdAt: NativeDate;
361
+ updatedAt: NativeDate;
362
+ } & {
363
+ _id: import("mongoose").Types.ObjectId;
364
+ tenant_id: string;
365
+ createdAt: NativeDate;
366
+ updatedAt: NativeDate;
367
+ brand_id: string;
368
+ day_index: import("../../constants").DAY_INDEX_ENUM;
369
+ iteration: number;
370
+ schema_version: number;
371
+ scope_context: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_SCOPE_ENUM;
372
+ scope_field: string;
373
+ sale_type_key_filters: string[];
374
+ sale_type_metrics: Map<string, {
375
+ TOTAL_SALES: {
376
+ orders: {
377
+ count: number;
378
+ discount_amount: number;
379
+ delivery_charges: number;
380
+ gst_amount: number;
381
+ tip_amount: number;
382
+ tax_amount: number;
383
+ tax_invoice_provider_charges: number;
384
+ gross_amount: number;
385
+ discount_by_type: {
386
+ special_discount: number;
387
+ loyalty_discount: number;
388
+ voucher_discount: number;
389
+ };
390
+ };
391
+ payments: import("mongoose").Types.DocumentArray<{
392
+ count: number;
393
+ card_charges: number;
394
+ payment_type: string;
395
+ amount_paid: number;
396
+ amount_due: number;
397
+ amount_refunded: number;
398
+ gross_amount: number;
399
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
400
+ count: number;
401
+ card_charges: number;
402
+ payment_type: string;
403
+ amount_paid: number;
404
+ amount_due: number;
405
+ amount_refunded: number;
406
+ gross_amount: number;
407
+ }> & {
408
+ count: number;
409
+ card_charges: number;
410
+ payment_type: string;
411
+ amount_paid: number;
412
+ amount_due: number;
413
+ amount_refunded: number;
414
+ gross_amount: number;
415
+ }>;
416
+ };
417
+ AMOUNT_COLLECTED: {
418
+ orders: {
419
+ count: number;
420
+ discount_amount: number;
421
+ delivery_charges: number;
422
+ gst_amount: number;
423
+ tip_amount: number;
424
+ tax_amount: number;
425
+ tax_invoice_provider_charges: number;
426
+ gross_amount: number;
427
+ discount_by_type: {
428
+ special_discount: number;
429
+ loyalty_discount: number;
430
+ voucher_discount: number;
431
+ };
432
+ };
433
+ payments: import("mongoose").Types.DocumentArray<{
434
+ count: number;
435
+ card_charges: number;
436
+ payment_type: string;
437
+ amount_paid: number;
438
+ amount_due: number;
439
+ amount_refunded: number;
440
+ gross_amount: number;
441
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
442
+ count: number;
443
+ card_charges: number;
444
+ payment_type: string;
445
+ amount_paid: number;
446
+ amount_due: number;
447
+ amount_refunded: number;
448
+ gross_amount: number;
449
+ }> & {
450
+ count: number;
451
+ card_charges: number;
452
+ payment_type: string;
453
+ amount_paid: number;
454
+ amount_due: number;
455
+ amount_refunded: number;
456
+ gross_amount: number;
457
+ }>;
458
+ };
459
+ CREDIT_BILLS: {
460
+ issued?: {
461
+ count: number;
462
+ amount: number;
463
+ settled_count: number;
464
+ settled_amount: number;
465
+ bills: import("mongoose").Types.DocumentArray<{
466
+ order_id: string;
467
+ payment_id: string;
468
+ amount: number;
469
+ received_amount: number;
470
+ credit_note: string;
471
+ issued_at: NativeDate;
472
+ settled_at: NativeDate;
473
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
474
+ order_id: string;
475
+ payment_id: string;
476
+ amount: number;
477
+ received_amount: number;
478
+ credit_note: string;
479
+ issued_at: NativeDate;
480
+ settled_at: NativeDate;
481
+ }> & {
482
+ order_id: string;
483
+ payment_id: string;
484
+ amount: number;
485
+ received_amount: number;
486
+ credit_note: string;
487
+ issued_at: NativeDate;
488
+ settled_at: NativeDate;
489
+ }>;
490
+ } | null | undefined;
491
+ received?: {
492
+ count: number;
493
+ amount: number;
494
+ bills: import("mongoose").Types.DocumentArray<{
495
+ order_id: string;
496
+ payment_id: string;
497
+ amount: number;
498
+ received_amount: number;
499
+ credit_note: string;
500
+ settled_at: NativeDate;
501
+ issued_local_date: string;
502
+ }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
503
+ order_id: string;
504
+ payment_id: string;
505
+ amount: number;
506
+ received_amount: number;
507
+ credit_note: string;
508
+ settled_at: NativeDate;
509
+ issued_local_date: string;
510
+ }> & {
511
+ order_id: string;
512
+ payment_id: string;
513
+ amount: number;
514
+ received_amount: number;
515
+ credit_note: string;
516
+ settled_at: NativeDate;
517
+ issued_local_date: string;
518
+ }>;
519
+ } | null | undefined;
520
+ };
521
+ }>;
522
+ source_watermark: NativeDate;
523
+ computed_at: NativeDate;
524
+ }> & Required<{
525
+ _id: import("mongoose").Types.ObjectId;
526
+ }> & {
527
+ __v: number;
528
+ }>;
529
+ export declare const MATERIALIZED_TENANT_SALES_OVERVIEW_REPORTS_COLLECTION_NAME = "materialized_tenant_sales_overview_reports";
530
+ /**
531
+ * Describes the indexes for `materialized_tenant_sales_overview_reports`.
532
+ * Values are Mongo key patterns that can be passed straight to `.hint()`.
533
+ * - `_id`: unique primary key.
534
+ * - `tenant_id__scope_context__scope_field`: UNIQUE index — one document per
535
+ * (tenant, scope context, scope value); also serves the standardized query
536
+ * (`tenant_id` + `scope_context` + `scope_field`).
537
+ * - `brand_id__scope_context__scope_field`: brand-level reads across the
538
+ * brand's tenants (sum across their tenant documents).
539
+ * - `tenant_id__scope_context__day_index__scope_field` (+ brand variant):
540
+ * weekday queries over LOCAL_HOUR / LOCAL_DATE slices
541
+ * (`day_index` + `scope_field` range).
542
+ */
543
+ export declare const MATERIALIZED_TENANT_SALES_OVERVIEW_REPORTS_COLLECTION_INDEXES: {
544
+ _id: {
545
+ _id: number;
546
+ };
547
+ tenant_id__scope_context__scope_field: {
548
+ tenant_id: number;
549
+ scope_context: number;
550
+ scope_field: number;
551
+ };
552
+ brand_id__scope_context__scope_field: {
553
+ brand_id: number;
554
+ scope_context: number;
555
+ scope_field: number;
556
+ };
557
+ tenant_id__scope_context__scope_field__day_index: {
558
+ tenant_id: number;
559
+ scope_context: number;
560
+ scope_field: number;
561
+ day_index: number;
562
+ };
563
+ brand_id__scope_context__scope_field__day_index: {
564
+ brand_id: number;
565
+ scope_context: number;
566
+ scope_field: number;
567
+ day_index: number;
568
+ };
569
+ };