@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.
- package/esm/constants/ENUMS.js +17 -1988
- package/esm/constants/MATERIALIZED_REPORTS.js +105 -0
- package/esm/constants/enums/cash.js +45 -0
- package/esm/constants/enums/communications.js +329 -0
- package/esm/constants/enums/delivery.js +35 -0
- package/esm/constants/enums/geo.js +150 -0
- package/esm/constants/enums/hr.js +130 -0
- package/esm/constants/enums/internal.js +132 -0
- package/esm/constants/enums/items.js +126 -0
- package/esm/constants/enums/misc.js +35 -0
- package/esm/constants/enums/offers.js +102 -0
- package/esm/constants/enums/order.js +135 -0
- package/esm/constants/enums/payments.js +186 -0
- package/esm/constants/enums/platform.js +215 -0
- package/esm/constants/enums/printing.js +107 -0
- package/esm/constants/enums/users.js +245 -0
- package/esm/constants/enums/wallet.js +32 -0
- package/esm/helpers/materialized-reports/index.js +5 -0
- package/esm/helpers/materialized-reports/key-helpers.js +59 -0
- package/esm/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.js +60 -0
- package/esm/helpers/materialized-reports/scope-helpers.js +107 -0
- package/esm/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +251 -0
- package/esm/helpers/materialized-reports/tenant-sales-overview-helpers.js +860 -0
- package/esm/helpers/store/cart-actions.js +1 -1
- package/esm/helpers/store/common-tenant-purchase-order-actions.js +7 -7
- package/esm/helpers/store/common-warehouse-purchase-order-actions.js +1 -1
- package/esm/helpers/store/common-warehouse-purchase-order-rfq-actions.js +1 -1
- package/esm/helpers/store/common-warehouse-sale-order-actions.js +1 -1
- package/esm/helpers/store/common-warehouse-sale-order-rfq-actions.js +1 -1
- package/esm/helpers/store/offline-ordering.js +1 -1
- package/esm/helpers/store/tenant-purchase-orders-cart-actions.js +1 -1
- package/esm/helpers/store/warehouse-purchase-order-rfq-cart-actions.js +1 -1
- package/esm/helpers/store/warehouse-purchase-orders-cart-actions.js +1 -1
- package/esm/helpers/store/warehouse-sale-order-rfq-cart-actions.js +1 -1
- package/esm/helpers/store/warehouse-sale-orders-cart-actions.js +1 -1
- package/esm/helpers/utils/cancellation-helpers.js +7 -0
- package/esm/helpers/utils/common.js +0 -46
- package/esm/helpers/utils/getFormFieldsDiff.js +1 -1
- package/esm/helpers/utils/index.js +2 -0
- package/esm/helpers/utils/phone-helpers.js +40 -0
- package/esm/helpers/utils/receipt-engine.js +3 -1
- package/esm/helpers/utils/specials-helpers.js +1 -1
- package/esm/helpers/utils/void-items-report-helpers.js +2 -1
- package/esm/schemas/models/materialized_tenant_reports_iterations.js +82 -0
- package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +399 -0
- package/esm/schemas/types/materialized_tenant_reports_iterations.js +1 -0
- package/esm/schemas/types/materialized_tenant_sales_overview_reports.js +1 -0
- package/lib/constants/ENUMS.d.ts +15 -1275
- package/lib/constants/ENUMS.js +31 -1994
- package/lib/constants/MATERIALIZED_REPORTS.d.ts +96 -0
- package/lib/constants/MATERIALIZED_REPORTS.js +108 -0
- package/lib/constants/enums/cash.d.ts +35 -0
- package/lib/constants/enums/cash.js +48 -0
- package/lib/constants/enums/communications.d.ts +79 -0
- package/lib/constants/enums/communications.js +332 -0
- package/lib/constants/enums/delivery.d.ts +26 -0
- package/lib/constants/enums/delivery.js +38 -0
- package/lib/constants/enums/geo.d.ts +133 -0
- package/lib/constants/enums/geo.js +153 -0
- package/lib/constants/enums/hr.d.ts +105 -0
- package/lib/constants/enums/hr.js +133 -0
- package/lib/constants/enums/internal.d.ts +104 -0
- package/lib/constants/enums/internal.js +135 -0
- package/lib/constants/enums/items.d.ts +94 -0
- package/lib/constants/enums/items.js +129 -0
- package/lib/constants/enums/misc.d.ts +25 -0
- package/lib/constants/enums/misc.js +38 -0
- package/lib/constants/enums/offers.d.ts +80 -0
- package/lib/constants/enums/offers.js +105 -0
- package/lib/constants/enums/order.d.ts +108 -0
- package/lib/constants/enums/order.js +138 -0
- package/lib/constants/enums/payments.d.ts +129 -0
- package/lib/constants/enums/payments.js +189 -0
- package/lib/constants/enums/platform.d.ts +100 -0
- package/lib/constants/enums/platform.js +218 -0
- package/lib/constants/enums/printing.d.ts +89 -0
- package/lib/constants/enums/printing.js +110 -0
- package/lib/constants/enums/users.d.ts +142 -0
- package/lib/constants/enums/users.js +248 -0
- package/lib/constants/enums/wallet.d.ts +26 -0
- package/lib/constants/enums/wallet.js +35 -0
- package/lib/helpers/materialized-reports/index.d.ts +5 -0
- package/lib/helpers/materialized-reports/index.js +21 -0
- package/lib/helpers/materialized-reports/key-helpers.d.ts +35 -0
- package/lib/helpers/materialized-reports/key-helpers.js +64 -0
- package/lib/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.d.ts +66 -0
- package/lib/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.js +63 -0
- package/lib/helpers/materialized-reports/scope-helpers.d.ts +57 -0
- package/lib/helpers/materialized-reports/scope-helpers.js +114 -0
- package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.d.ts +125 -0
- package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +256 -0
- package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.d.ts +223 -0
- package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.js +875 -0
- package/lib/helpers/store/cart-actions.js +6 -6
- package/lib/helpers/store/common-tenant-purchase-order-actions.d.ts +2 -2
- package/lib/helpers/store/common-tenant-purchase-order-actions.js +10 -10
- package/lib/helpers/store/common-warehouse-purchase-order-actions.js +4 -4
- package/lib/helpers/store/common-warehouse-purchase-order-rfq-actions.js +4 -4
- package/lib/helpers/store/common-warehouse-sale-order-actions.js +4 -4
- package/lib/helpers/store/common-warehouse-sale-order-rfq-actions.js +4 -4
- package/lib/helpers/store/offline-ordering.js +2 -2
- package/lib/helpers/store/tenant-purchase-orders-cart-actions.js +2 -2
- package/lib/helpers/store/warehouse-purchase-order-rfq-cart-actions.js +2 -2
- package/lib/helpers/store/warehouse-purchase-orders-cart-actions.js +2 -2
- package/lib/helpers/store/warehouse-sale-order-rfq-cart-actions.js +2 -2
- package/lib/helpers/store/warehouse-sale-orders-cart-actions.js +2 -2
- package/lib/helpers/utils/cancellation-helpers.d.ts +1 -0
- package/lib/helpers/utils/cancellation-helpers.js +13 -0
- package/lib/helpers/utils/common.d.ts +0 -6
- package/lib/helpers/utils/common.js +1 -54
- package/lib/helpers/utils/getFormFieldsDiff.js +5 -2
- package/lib/helpers/utils/index.d.ts +2 -0
- package/lib/helpers/utils/index.js +2 -0
- package/lib/helpers/utils/phone-helpers.d.ts +5 -0
- package/lib/helpers/utils/phone-helpers.js +46 -0
- package/lib/helpers/utils/receipt-engine.js +4 -2
- package/lib/helpers/utils/specials-helpers.js +2 -2
- package/lib/helpers/utils/void-items-report-helpers.js +3 -2
- package/lib/schemas/models/materialized_tenant_reports_iterations.d.ts +80 -0
- package/lib/schemas/models/materialized_tenant_reports_iterations.js +85 -0
- package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +569 -0
- package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +402 -0
- package/lib/schemas/types/materialized_tenant_reports_iterations.d.ts +62 -0
- package/lib/schemas/types/materialized_tenant_reports_iterations.js +2 -0
- package/lib/schemas/types/materialized_tenant_sales_overview_reports.d.ts +242 -0
- package/lib/schemas/types/materialized_tenant_sales_overview_reports.js +3 -0
- package/lib/tests/materialized-reports/fixtures.d.ts +81 -0
- package/lib/tests/materialized-reports/fixtures.js +87 -0
- package/lib/tests/materialized-reports/fixtures.test.d.ts +1 -0
- package/lib/tests/materialized-reports/fixtures.test.js +123 -0
- package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-helpers.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-helpers.test.js +75 -0
- package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-schema.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-schema.test.js +73 -0
- package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.js +207 -0
- package/lib/tests/materialized-reports/sales-overview-baseline.test.d.ts +1 -0
- package/lib/tests/materialized-reports/sales-overview-baseline.test.js +326 -0
- package/lib/tests/materialized-reports/sales-overview-reference.d.ts +63 -0
- package/lib/tests/materialized-reports/sales-overview-reference.js +131 -0
- package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.d.ts +1 -0
- package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.js +335 -0
- package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.d.ts +1 -0
- package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.js +885 -0
- package/package.json +5 -2
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Constants for the `materialized_*` report collections (see
|
|
3
|
+
* `MATERIALIZED_REPORTS.md`).
|
|
4
|
+
*
|
|
5
|
+
* NOTE: during the current development phase the materialized-report files
|
|
6
|
+
* stay self-contained — this file is NOT (yet) re-exported from
|
|
7
|
+
* `src/constants/index.ts`; the report schema/type files import it via
|
|
8
|
+
* relative paths. Wiring re-exports into the barrels is a separate,
|
|
9
|
+
* explicitly-enabled step.
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* Time-scope of a materialized report document. Every document covers exactly
|
|
13
|
+
* one tenant × one scope context × one scope value (`scope_field`), and the
|
|
14
|
+
* same scope set is shared by every materialized report collection.
|
|
15
|
+
*
|
|
16
|
+
* `scope_field` formats (all strings), derived from the existing toolkit time
|
|
17
|
+
* helpers (`getLocalDocumentFields`, `getIsoWeekOfYear`, `getCalendarWeekStart`)
|
|
18
|
+
* for the order's business day (`order.localDate`) — hours use the PUNCH hour
|
|
19
|
+
* for sales and the SETTLEMENT hour for credit-bill collections:
|
|
20
|
+
* - `LOCAL_HOUR`: 'YYYY-MM-DD HH' — e.g. '2026-09-15 18' (one hour of one day)
|
|
21
|
+
* - `LOCAL_DATE`: 'YYYY-MM-DD' — e.g. '2026-09-15'
|
|
22
|
+
* - `LOCAL_WEEK`: 'YYYY-MM-DD' — week start (Sun–Sat, the calendar UI's
|
|
23
|
+
* convention: `getCalendarWeekStart(date, 0)`)
|
|
24
|
+
* - `LOCAL_WEEK_OF_YEAR`: 'YYYY-Wnn' — ISO week (`getIsoWeekOfYear`); `YYYY` is the
|
|
25
|
+
* ISO week-year for boundary weeks
|
|
26
|
+
* - `LOCAL_MONTH`: 'YYYY-MM' — e.g. '2026-09'
|
|
27
|
+
* - `LOCAL_QUARTER`: 'YYYY-Qn' — e.g. '2026-Q3'
|
|
28
|
+
* - `LOCAL_SEMESTER`: 'YYYY-Sn' — e.g. '2026-S2'
|
|
29
|
+
* - `LOCAL_YEAR`: 'YYYY' — e.g. '2026'
|
|
30
|
+
*
|
|
31
|
+
* `DAY_INDEX` is intentionally NOT a scope: a weekday accumulator has no time
|
|
32
|
+
* anchor — it cannot honor date-range filters and would grow forever. Instead,
|
|
33
|
+
* `LOCAL_HOUR` and `LOCAL_DATE` documents carry a denormalized `day_index`
|
|
34
|
+
* field (`DAY_INDEX_ENUM`) so weekday filtering/grouping is a plain query over
|
|
35
|
+
* the date/hour slices (see `MATERIALIZED_REPORT_SCOPES_WITH_DAY_INDEX`).
|
|
36
|
+
*
|
|
37
|
+
* The day-end materialization job compiles the tenant's day into the report
|
|
38
|
+
* collections: up to 24 `LOCAL_HOUR` documents plus one document for each
|
|
39
|
+
* other scope (31 per tenant-day; the longer-period documents accumulate until
|
|
40
|
+
* their period ends). Changing scope values or their formats requires a
|
|
41
|
+
* `schema_version` bump and re-materialization of history.
|
|
42
|
+
*/
|
|
43
|
+
export declare enum MATERIALIZED_REPORT_SCOPE_ENUM {
|
|
44
|
+
LOCAL_HOUR = "localHour",
|
|
45
|
+
LOCAL_DATE = "localDate",
|
|
46
|
+
LOCAL_WEEK = "localWeek",
|
|
47
|
+
LOCAL_WEEK_OF_YEAR = "localWeekOfYear",
|
|
48
|
+
LOCAL_MONTH = "localMonth",
|
|
49
|
+
LOCAL_QUARTER = "localQuarter",
|
|
50
|
+
LOCAL_SEMESTER = "localSemester",
|
|
51
|
+
LOCAL_YEAR = "localYear"
|
|
52
|
+
}
|
|
53
|
+
export declare const ALL_MATERIALIZED_REPORT_SCOPES: MATERIALIZED_REPORT_SCOPE_ENUM[];
|
|
54
|
+
/**
|
|
55
|
+
* Scopes whose documents carry the denormalized `day_index` weekday field
|
|
56
|
+
* (derived from `scope_field` by the materializer, `DAY_INDEX_ENUM`). All
|
|
57
|
+
* other scopes must leave it `null` — weekday analysis reads date/hour slices
|
|
58
|
+
* (`LOCAL_HOUR` / `LOCAL_DATE`) instead of an all-time accumulator document.
|
|
59
|
+
*/
|
|
60
|
+
export declare const MATERIALIZED_REPORT_SCOPES_WITH_DAY_INDEX: MATERIALIZED_REPORT_SCOPE_ENUM[];
|
|
61
|
+
/**
|
|
62
|
+
* Filter dimensions that can be encoded into the metric keys of a materialized
|
|
63
|
+
* report document (`sale_type_metrics`). The declaration order defines the key
|
|
64
|
+
* grammar: `<DIM_1>:<DIM_2>:...` built from raw enum/live string values
|
|
65
|
+
* (e.g. `PLACED:POS_WALK-IN`). Changing the dimensions or their order requires
|
|
66
|
+
* a `schema_version` bump and re-materialization of historical documents.
|
|
67
|
+
*/
|
|
68
|
+
export declare enum MATERIALIZED_REPORT_KEY_FILTER_ENUM {
|
|
69
|
+
ORDER_STATUS = "ORDER_STATUS",
|
|
70
|
+
PLATFORM = "PLATFORM"
|
|
71
|
+
}
|
|
72
|
+
export declare const ALL_MATERIALIZED_REPORT_KEY_FILTERS: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
|
|
73
|
+
/** Ordered key filters of the tenant sales overview report (`PLACED:POS_WALK-IN`). */
|
|
74
|
+
export declare const SALES_OVERVIEW_KEY_FILTERS: MATERIALIZED_REPORT_KEY_FILTER_ENUM[];
|
|
75
|
+
/**
|
|
76
|
+
* Payment-type label used by the frontend report formatter for the derived
|
|
77
|
+
* credit-settlement line in a collection day's payments breakdown (a
|
|
78
|
+
* `PAY_LATER` bill collected on a later day). NOT stored in materialized docs —
|
|
79
|
+
* the formatter composes the line from the `CREDIT_BILLS` ledger's `received`
|
|
80
|
+
* bucket. The line is excluded from method buckets (CASH/CARD/…) and never
|
|
81
|
+
* feeds gross: gross stays sales-only, so cross-day gross sums stay equal to
|
|
82
|
+
* total sales.
|
|
83
|
+
*/
|
|
84
|
+
export declare const MATERIALIZED_CREDIT_SETTLEMENT_PAYMENT_TYPE = "CREDIT_SETTLEMENT";
|
|
85
|
+
/**
|
|
86
|
+
* Materialized report kinds — the discriminator stored on
|
|
87
|
+
* `materialized_tenant_reports_iterations` rows. A single shared history collection records
|
|
88
|
+
* the structural iterations of EVERY materialized report, so each row must
|
|
89
|
+
* declare which report collection its `report_id` belongs to. Add one member
|
|
90
|
+
* per new report collection (Summary / X / Z / Riders / Items / Void Items …)
|
|
91
|
+
* as it lands.
|
|
92
|
+
*/
|
|
93
|
+
export declare enum MATERIALIZED_REPORT_TYPE_ENUM {
|
|
94
|
+
TENANT_SALES_OVERVIEW = "TENANT_SALES_OVERVIEW"
|
|
95
|
+
}
|
|
96
|
+
export declare const ALL_MATERIALIZED_REPORT_TYPES: MATERIALIZED_REPORT_TYPE_ENUM.TENANT_SALES_OVERVIEW[];
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Constants for the `materialized_*` report collections (see
|
|
4
|
+
* `MATERIALIZED_REPORTS.md`).
|
|
5
|
+
*
|
|
6
|
+
* NOTE: during the current development phase the materialized-report files
|
|
7
|
+
* stay self-contained — this file is NOT (yet) re-exported from
|
|
8
|
+
* `src/constants/index.ts`; the report schema/type files import it via
|
|
9
|
+
* relative paths. Wiring re-exports into the barrels is a separate,
|
|
10
|
+
* explicitly-enabled step.
|
|
11
|
+
*/
|
|
12
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
exports.ALL_MATERIALIZED_REPORT_TYPES = exports.MATERIALIZED_REPORT_TYPE_ENUM = exports.MATERIALIZED_CREDIT_SETTLEMENT_PAYMENT_TYPE = exports.SALES_OVERVIEW_KEY_FILTERS = exports.ALL_MATERIALIZED_REPORT_KEY_FILTERS = exports.MATERIALIZED_REPORT_KEY_FILTER_ENUM = exports.MATERIALIZED_REPORT_SCOPES_WITH_DAY_INDEX = exports.ALL_MATERIALIZED_REPORT_SCOPES = exports.MATERIALIZED_REPORT_SCOPE_ENUM = void 0;
|
|
14
|
+
/**
|
|
15
|
+
* Time-scope of a materialized report document. Every document covers exactly
|
|
16
|
+
* one tenant × one scope context × one scope value (`scope_field`), and the
|
|
17
|
+
* same scope set is shared by every materialized report collection.
|
|
18
|
+
*
|
|
19
|
+
* `scope_field` formats (all strings), derived from the existing toolkit time
|
|
20
|
+
* helpers (`getLocalDocumentFields`, `getIsoWeekOfYear`, `getCalendarWeekStart`)
|
|
21
|
+
* for the order's business day (`order.localDate`) — hours use the PUNCH hour
|
|
22
|
+
* for sales and the SETTLEMENT hour for credit-bill collections:
|
|
23
|
+
* - `LOCAL_HOUR`: 'YYYY-MM-DD HH' — e.g. '2026-09-15 18' (one hour of one day)
|
|
24
|
+
* - `LOCAL_DATE`: 'YYYY-MM-DD' — e.g. '2026-09-15'
|
|
25
|
+
* - `LOCAL_WEEK`: 'YYYY-MM-DD' — week start (Sun–Sat, the calendar UI's
|
|
26
|
+
* convention: `getCalendarWeekStart(date, 0)`)
|
|
27
|
+
* - `LOCAL_WEEK_OF_YEAR`: 'YYYY-Wnn' — ISO week (`getIsoWeekOfYear`); `YYYY` is the
|
|
28
|
+
* ISO week-year for boundary weeks
|
|
29
|
+
* - `LOCAL_MONTH`: 'YYYY-MM' — e.g. '2026-09'
|
|
30
|
+
* - `LOCAL_QUARTER`: 'YYYY-Qn' — e.g. '2026-Q3'
|
|
31
|
+
* - `LOCAL_SEMESTER`: 'YYYY-Sn' — e.g. '2026-S2'
|
|
32
|
+
* - `LOCAL_YEAR`: 'YYYY' — e.g. '2026'
|
|
33
|
+
*
|
|
34
|
+
* `DAY_INDEX` is intentionally NOT a scope: a weekday accumulator has no time
|
|
35
|
+
* anchor — it cannot honor date-range filters and would grow forever. Instead,
|
|
36
|
+
* `LOCAL_HOUR` and `LOCAL_DATE` documents carry a denormalized `day_index`
|
|
37
|
+
* field (`DAY_INDEX_ENUM`) so weekday filtering/grouping is a plain query over
|
|
38
|
+
* the date/hour slices (see `MATERIALIZED_REPORT_SCOPES_WITH_DAY_INDEX`).
|
|
39
|
+
*
|
|
40
|
+
* The day-end materialization job compiles the tenant's day into the report
|
|
41
|
+
* collections: up to 24 `LOCAL_HOUR` documents plus one document for each
|
|
42
|
+
* other scope (31 per tenant-day; the longer-period documents accumulate until
|
|
43
|
+
* their period ends). Changing scope values or their formats requires a
|
|
44
|
+
* `schema_version` bump and re-materialization of history.
|
|
45
|
+
*/
|
|
46
|
+
var MATERIALIZED_REPORT_SCOPE_ENUM;
|
|
47
|
+
(function (MATERIALIZED_REPORT_SCOPE_ENUM) {
|
|
48
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_HOUR"] = "localHour";
|
|
49
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_DATE"] = "localDate";
|
|
50
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_WEEK"] = "localWeek";
|
|
51
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_WEEK_OF_YEAR"] = "localWeekOfYear";
|
|
52
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_MONTH"] = "localMonth";
|
|
53
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_QUARTER"] = "localQuarter";
|
|
54
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_SEMESTER"] = "localSemester";
|
|
55
|
+
MATERIALIZED_REPORT_SCOPE_ENUM["LOCAL_YEAR"] = "localYear";
|
|
56
|
+
})(MATERIALIZED_REPORT_SCOPE_ENUM || (exports.MATERIALIZED_REPORT_SCOPE_ENUM = MATERIALIZED_REPORT_SCOPE_ENUM = {}));
|
|
57
|
+
exports.ALL_MATERIALIZED_REPORT_SCOPES = Object.values(MATERIALIZED_REPORT_SCOPE_ENUM);
|
|
58
|
+
/**
|
|
59
|
+
* Scopes whose documents carry the denormalized `day_index` weekday field
|
|
60
|
+
* (derived from `scope_field` by the materializer, `DAY_INDEX_ENUM`). All
|
|
61
|
+
* other scopes must leave it `null` — weekday analysis reads date/hour slices
|
|
62
|
+
* (`LOCAL_HOUR` / `LOCAL_DATE`) instead of an all-time accumulator document.
|
|
63
|
+
*/
|
|
64
|
+
exports.MATERIALIZED_REPORT_SCOPES_WITH_DAY_INDEX = [
|
|
65
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_HOUR,
|
|
66
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_DATE,
|
|
67
|
+
];
|
|
68
|
+
/**
|
|
69
|
+
* Filter dimensions that can be encoded into the metric keys of a materialized
|
|
70
|
+
* report document (`sale_type_metrics`). The declaration order defines the key
|
|
71
|
+
* grammar: `<DIM_1>:<DIM_2>:...` built from raw enum/live string values
|
|
72
|
+
* (e.g. `PLACED:POS_WALK-IN`). Changing the dimensions or their order requires
|
|
73
|
+
* a `schema_version` bump and re-materialization of historical documents.
|
|
74
|
+
*/
|
|
75
|
+
var MATERIALIZED_REPORT_KEY_FILTER_ENUM;
|
|
76
|
+
(function (MATERIALIZED_REPORT_KEY_FILTER_ENUM) {
|
|
77
|
+
MATERIALIZED_REPORT_KEY_FILTER_ENUM["ORDER_STATUS"] = "ORDER_STATUS";
|
|
78
|
+
MATERIALIZED_REPORT_KEY_FILTER_ENUM["PLATFORM"] = "PLATFORM";
|
|
79
|
+
})(MATERIALIZED_REPORT_KEY_FILTER_ENUM || (exports.MATERIALIZED_REPORT_KEY_FILTER_ENUM = MATERIALIZED_REPORT_KEY_FILTER_ENUM = {}));
|
|
80
|
+
exports.ALL_MATERIALIZED_REPORT_KEY_FILTERS = Object.values(MATERIALIZED_REPORT_KEY_FILTER_ENUM);
|
|
81
|
+
/** Ordered key filters of the tenant sales overview report (`PLACED:POS_WALK-IN`). */
|
|
82
|
+
exports.SALES_OVERVIEW_KEY_FILTERS = [
|
|
83
|
+
MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS,
|
|
84
|
+
MATERIALIZED_REPORT_KEY_FILTER_ENUM.PLATFORM,
|
|
85
|
+
];
|
|
86
|
+
/**
|
|
87
|
+
* Payment-type label used by the frontend report formatter for the derived
|
|
88
|
+
* credit-settlement line in a collection day's payments breakdown (a
|
|
89
|
+
* `PAY_LATER` bill collected on a later day). NOT stored in materialized docs —
|
|
90
|
+
* the formatter composes the line from the `CREDIT_BILLS` ledger's `received`
|
|
91
|
+
* bucket. The line is excluded from method buckets (CASH/CARD/…) and never
|
|
92
|
+
* feeds gross: gross stays sales-only, so cross-day gross sums stay equal to
|
|
93
|
+
* total sales.
|
|
94
|
+
*/
|
|
95
|
+
exports.MATERIALIZED_CREDIT_SETTLEMENT_PAYMENT_TYPE = 'CREDIT_SETTLEMENT';
|
|
96
|
+
/**
|
|
97
|
+
* Materialized report kinds — the discriminator stored on
|
|
98
|
+
* `materialized_tenant_reports_iterations` rows. A single shared history collection records
|
|
99
|
+
* the structural iterations of EVERY materialized report, so each row must
|
|
100
|
+
* declare which report collection its `report_id` belongs to. Add one member
|
|
101
|
+
* per new report collection (Summary / X / Z / Riders / Items / Void Items …)
|
|
102
|
+
* as it lands.
|
|
103
|
+
*/
|
|
104
|
+
var MATERIALIZED_REPORT_TYPE_ENUM;
|
|
105
|
+
(function (MATERIALIZED_REPORT_TYPE_ENUM) {
|
|
106
|
+
MATERIALIZED_REPORT_TYPE_ENUM["TENANT_SALES_OVERVIEW"] = "TENANT_SALES_OVERVIEW";
|
|
107
|
+
})(MATERIALIZED_REPORT_TYPE_ENUM || (exports.MATERIALIZED_REPORT_TYPE_ENUM = MATERIALIZED_REPORT_TYPE_ENUM = {}));
|
|
108
|
+
exports.ALL_MATERIALIZED_REPORT_TYPES = Object.values(MATERIALIZED_REPORT_TYPE_ENUM);
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
export declare enum TENANT_AMOUNT_DUE_TYPE_ENUM {
|
|
2
|
+
SMS = "SMS",
|
|
3
|
+
EMAIL = "EMAIL",
|
|
4
|
+
WHATSAPP = "WHATSAPP",
|
|
5
|
+
NOTIFICATION = "NOTIFICATION",
|
|
6
|
+
SUBSCRIPTION = "SUBSCRIPTION",
|
|
7
|
+
HARDWARE = "HARDWARE",
|
|
8
|
+
PHOTOGRAPHY = "PHOTOGRAPHY",
|
|
9
|
+
SHIPPING = "SHIPPING",
|
|
10
|
+
PAYOUT_FEE = "PAYOUT_FEE"
|
|
11
|
+
}
|
|
12
|
+
export declare enum CASH_IN_OUT_TYPE_ENUM {
|
|
13
|
+
CASH_IN = "CASH_IN",
|
|
14
|
+
CASH_OUT = "CASH_OUT"
|
|
15
|
+
}
|
|
16
|
+
export declare const ALL_CASH_IN_OUT_TYPES: CASH_IN_OUT_TYPE_ENUM[];
|
|
17
|
+
export declare enum CASH_IN_OUT_REF_ENUM {
|
|
18
|
+
NONE = "NONE",
|
|
19
|
+
ORDER = "ORDER",
|
|
20
|
+
EXPENSE = "EXPENSE",
|
|
21
|
+
DRAWER = "DRAWER",
|
|
22
|
+
SYSTEM_ADJUSTMENT = "SYSTEM_ADJUSTMENT"
|
|
23
|
+
}
|
|
24
|
+
export declare const ALL_CASH_IN_OUT_REFS: CASH_IN_OUT_REF_ENUM[];
|
|
25
|
+
export declare enum CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM {
|
|
26
|
+
TOP_UP = "TOP_UP",
|
|
27
|
+
DEPOSIT = "DEPOSIT",
|
|
28
|
+
ADJUST = "ADJUST"
|
|
29
|
+
}
|
|
30
|
+
export declare const ALL_CASH_IN_HAND_TRANSACTION_CATEGORIES: CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM[];
|
|
31
|
+
export declare enum CASH_DRAWER_STATUS_ENUM {
|
|
32
|
+
IN_USE = "IN_USE",
|
|
33
|
+
CLOSED = "CLOSED"
|
|
34
|
+
}
|
|
35
|
+
export declare const ALL_CASH_DRAWER_STATUS: CASH_DRAWER_STATUS_ENUM[];
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Auto-split from constants/ENUMS.ts — see ENUMS.ts barrel for exports.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ALL_CASH_DRAWER_STATUS = exports.CASH_DRAWER_STATUS_ENUM = exports.ALL_CASH_IN_HAND_TRANSACTION_CATEGORIES = exports.CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM = exports.ALL_CASH_IN_OUT_REFS = exports.CASH_IN_OUT_REF_ENUM = exports.ALL_CASH_IN_OUT_TYPES = exports.CASH_IN_OUT_TYPE_ENUM = exports.TENANT_AMOUNT_DUE_TYPE_ENUM = void 0;
|
|
5
|
+
var TENANT_AMOUNT_DUE_TYPE_ENUM;
|
|
6
|
+
(function (TENANT_AMOUNT_DUE_TYPE_ENUM) {
|
|
7
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["SMS"] = "SMS";
|
|
8
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["EMAIL"] = "EMAIL";
|
|
9
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["WHATSAPP"] = "WHATSAPP";
|
|
10
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["NOTIFICATION"] = "NOTIFICATION";
|
|
11
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["SUBSCRIPTION"] = "SUBSCRIPTION";
|
|
12
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["HARDWARE"] = "HARDWARE";
|
|
13
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["PHOTOGRAPHY"] = "PHOTOGRAPHY";
|
|
14
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["SHIPPING"] = "SHIPPING";
|
|
15
|
+
TENANT_AMOUNT_DUE_TYPE_ENUM["PAYOUT_FEE"] = "PAYOUT_FEE";
|
|
16
|
+
})(TENANT_AMOUNT_DUE_TYPE_ENUM || (exports.TENANT_AMOUNT_DUE_TYPE_ENUM = TENANT_AMOUNT_DUE_TYPE_ENUM = {}));
|
|
17
|
+
var CASH_IN_OUT_TYPE_ENUM;
|
|
18
|
+
(function (CASH_IN_OUT_TYPE_ENUM) {
|
|
19
|
+
CASH_IN_OUT_TYPE_ENUM["CASH_IN"] = "CASH_IN";
|
|
20
|
+
CASH_IN_OUT_TYPE_ENUM["CASH_OUT"] = "CASH_OUT";
|
|
21
|
+
})(CASH_IN_OUT_TYPE_ENUM || (exports.CASH_IN_OUT_TYPE_ENUM = CASH_IN_OUT_TYPE_ENUM = {}));
|
|
22
|
+
exports.ALL_CASH_IN_OUT_TYPES = Object.values(CASH_IN_OUT_TYPE_ENUM);
|
|
23
|
+
// ======================>> <<====================== //
|
|
24
|
+
var CASH_IN_OUT_REF_ENUM;
|
|
25
|
+
(function (CASH_IN_OUT_REF_ENUM) {
|
|
26
|
+
CASH_IN_OUT_REF_ENUM["NONE"] = "NONE";
|
|
27
|
+
CASH_IN_OUT_REF_ENUM["ORDER"] = "ORDER";
|
|
28
|
+
CASH_IN_OUT_REF_ENUM["EXPENSE"] = "EXPENSE";
|
|
29
|
+
CASH_IN_OUT_REF_ENUM["DRAWER"] = "DRAWER";
|
|
30
|
+
CASH_IN_OUT_REF_ENUM["SYSTEM_ADJUSTMENT"] = "SYSTEM_ADJUSTMENT";
|
|
31
|
+
})(CASH_IN_OUT_REF_ENUM || (exports.CASH_IN_OUT_REF_ENUM = CASH_IN_OUT_REF_ENUM = {}));
|
|
32
|
+
exports.ALL_CASH_IN_OUT_REFS = Object.values(CASH_IN_OUT_REF_ENUM);
|
|
33
|
+
// ======================>> <<====================== //
|
|
34
|
+
var CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM;
|
|
35
|
+
(function (CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM) {
|
|
36
|
+
CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM["TOP_UP"] = "TOP_UP";
|
|
37
|
+
CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM["DEPOSIT"] = "DEPOSIT";
|
|
38
|
+
CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM["ADJUST"] = "ADJUST";
|
|
39
|
+
})(CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM || (exports.CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM = CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM = {}));
|
|
40
|
+
exports.ALL_CASH_IN_HAND_TRANSACTION_CATEGORIES = Object.values(CASH_IN_HAND_TRANSACTION_CATEGORY_ENUM);
|
|
41
|
+
// ======================>> <<====================== //
|
|
42
|
+
var CASH_DRAWER_STATUS_ENUM;
|
|
43
|
+
(function (CASH_DRAWER_STATUS_ENUM) {
|
|
44
|
+
CASH_DRAWER_STATUS_ENUM["IN_USE"] = "IN_USE";
|
|
45
|
+
CASH_DRAWER_STATUS_ENUM["CLOSED"] = "CLOSED";
|
|
46
|
+
})(CASH_DRAWER_STATUS_ENUM || (exports.CASH_DRAWER_STATUS_ENUM = CASH_DRAWER_STATUS_ENUM = {}));
|
|
47
|
+
exports.ALL_CASH_DRAWER_STATUS = Object.values(CASH_DRAWER_STATUS_ENUM);
|
|
48
|
+
// ======================>> <<====================== //
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
export declare enum SMS_PROCESSING_PROVIDERS_ENUM {
|
|
2
|
+
NONE = "NONE"
|
|
3
|
+
}
|
|
4
|
+
export declare const ALL_SMS_PROCESSING_PROVIDERS: SMS_PROCESSING_PROVIDERS_ENUM.NONE[];
|
|
5
|
+
export declare enum EMAIL_PROCESSING_PROVIDERS_ENUM {
|
|
6
|
+
NONE = "NONE"
|
|
7
|
+
}
|
|
8
|
+
export declare const ALL_EMAIL_PROCESSING_PROVIDERS: EMAIL_PROCESSING_PROVIDERS_ENUM.NONE[];
|
|
9
|
+
export declare enum EMAIL_DOCUMENT_KIND_ENUM {
|
|
10
|
+
RFQ = "RFQ",
|
|
11
|
+
PURCHASE_ORDER = "PURCHASE_ORDER",
|
|
12
|
+
SALE_RFQ = "SALE_RFQ",
|
|
13
|
+
SALE_ORDER = "SALE_ORDER"
|
|
14
|
+
}
|
|
15
|
+
export declare const ALL_EMAIL_DOCUMENT_KINDS: EMAIL_DOCUMENT_KIND_ENUM[];
|
|
16
|
+
export declare enum COMMUNICATION_CHANNEL_ENUM {
|
|
17
|
+
EMAIL = "EMAIL",
|
|
18
|
+
WHATSAPP = "WHATSAPP",
|
|
19
|
+
OTHER = "OTHER"
|
|
20
|
+
}
|
|
21
|
+
export declare const ALL_COMMUNICATION_CHANNELS: COMMUNICATION_CHANNEL_ENUM[];
|
|
22
|
+
export declare enum EMAIL_STATUS_ENUM {
|
|
23
|
+
PENDING = "PENDING",
|
|
24
|
+
SENT = "SENT",
|
|
25
|
+
FAILED = "FAILED"
|
|
26
|
+
}
|
|
27
|
+
export declare const ALL_EMAIL_STATUS: EMAIL_STATUS_ENUM[];
|
|
28
|
+
export declare enum TOKEN_TYPE_ENUM {
|
|
29
|
+
ORDER_REVIEW = "ORDER_REVIEW"
|
|
30
|
+
}
|
|
31
|
+
export declare const ALL_TOKEN_TYPES: TOKEN_TYPE_ENUM.ORDER_REVIEW[];
|
|
32
|
+
export declare enum MARKETING_TYPE_ENUM {
|
|
33
|
+
SMS = "SMS",
|
|
34
|
+
EMAIL = "EMAIL",
|
|
35
|
+
WHATSAPP = "WHATSAPP",
|
|
36
|
+
NOTIFICATION = "NOTIFICATION"
|
|
37
|
+
}
|
|
38
|
+
export declare const ALL_MARKETING_TYPES: MARKETING_TYPE_ENUM[];
|
|
39
|
+
export declare enum MARKETING_RECEIPIENT_ENUM {
|
|
40
|
+
TOP_CUSTOMERS = "TOP_CUSTOMERS",
|
|
41
|
+
TOP_TAKEAWAY_CUSTOMERS = "TOP_TAKEAWAY_CUSTOMERS",
|
|
42
|
+
TOP_DELIVERY_CUSTOMERS = "TOP_DELIVERY_CUSTOMERS",
|
|
43
|
+
IN_ACTIVE_CUSTOMERS = "IN_ACTIVE_CUSTOMERS",
|
|
44
|
+
SPECIFIC_CUSTOMERS = "SPECIFIC_CUSTOMERS"
|
|
45
|
+
}
|
|
46
|
+
export declare const ALL_MARKETING_RECEIPIENT_TYPES: MARKETING_RECEIPIENT_ENUM[];
|
|
47
|
+
export declare const BLACKLISTED_SMS_COUNTRY_CODES: string[];
|
|
48
|
+
export declare const WHITELISTED_API_SMS_COUNTRY_CODES: string[];
|
|
49
|
+
export declare enum ALERT_NOTIFICATIONS_TYPE_ENUM {
|
|
50
|
+
UNCONFIRMED_ORDER_DELAY = "UNCONFIRMED_ORDER_DELAY",
|
|
51
|
+
LOW_INVENTORY_STOCK = "LOW_INVENTORY_STOCK",
|
|
52
|
+
LATE_DELIVERY = "LATE_DELIVERY"
|
|
53
|
+
}
|
|
54
|
+
export declare const ALL_ALERT_NOTIFICATIONS_TYPES: ALERT_NOTIFICATIONS_TYPE_ENUM[];
|
|
55
|
+
export declare enum EMAIL_TEMPLATES_TYPE_ENUM {
|
|
56
|
+
ACCOUNT_ACTIVATED = "ACCOUNT_ACTIVATED",
|
|
57
|
+
ACCOUNT_DEACTIVATED = "ACCOUNT_DEACTIVATED",
|
|
58
|
+
LATE_DELIVERY_ALERT = "LATE_DELIVERY_ALERT",
|
|
59
|
+
LOW_INVENTORY_ALERT = "LOW_INVENTORY_ALERT",
|
|
60
|
+
UNCONFIRMED_ORDER_ALERT = "UNCONFIRMED_ORDER_ALERT",
|
|
61
|
+
ORDER_RECEIPT = "ORDER_RECEIPT",
|
|
62
|
+
ORDER_STATUS_UPDATE = "ORDER_STATUS_UPDATE",
|
|
63
|
+
RATE_ORDER = "RATE_ORDER",
|
|
64
|
+
RECEIVED_ORDER_REVIEW = "RECEIVED_ORDER_REVIEW",
|
|
65
|
+
SUBSCRIPTION_DUE_SOON = "SUBSCRIPTION_DUE_SOON",
|
|
66
|
+
SUBSCRIPTION_PENDING = "SUBSCRIPTION_PENDING",
|
|
67
|
+
SUBSCRIPTION_EXPIRED = "SUBSCRIPTION_EXPIRED",
|
|
68
|
+
SUBSCRIPTION_RENEWED = "SUBSCRIPTION_RENEWED",
|
|
69
|
+
WELCOME = "WELCOME",
|
|
70
|
+
MARKETING_FORM_SUBMISSION = "MARKETING_FORM_SUBMISSION",
|
|
71
|
+
EMAIL_TEMPLATE_FOR_RFQ = "EMAIL_TEMPLATE_FOR_RFQ",
|
|
72
|
+
EMAIL_TEMPLATE_FOR_PURCHASE_ORDER = "EMAIL_TEMPLATE_FOR_PURCHASE_ORDER",
|
|
73
|
+
EMAIL_TEMPLATE_FOR_SALE_ORDER = "EMAIL_TEMPLATE_FOR_SALE_ORDER"
|
|
74
|
+
}
|
|
75
|
+
export declare enum NOTIFICATION_PROVIDER_ENUM {
|
|
76
|
+
FIREBASE = "FIREBASE",
|
|
77
|
+
EXPO = "EXPO"
|
|
78
|
+
}
|
|
79
|
+
export declare const ALL_NOTIFICATION_PROVIDERS: NOTIFICATION_PROVIDER_ENUM[];
|