@managesome/eposmatic-toolkit 0.4.59 → 0.4.61
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/MATERIALIZED_REPORTS.js +177 -8
- package/esm/helpers/materialized-reports/index.js +7 -0
- package/esm/helpers/materialized-reports/materialized-day-readiness.js +2 -2
- package/esm/helpers/materialized-reports/materialized-dinein-accumulator-helpers.js +557 -0
- package/esm/helpers/materialized-reports/materialized-dinein-classification-helpers.js +447 -0
- package/esm/helpers/materialized-reports/materialized-dinein-close-day-helpers.js +372 -0
- package/esm/helpers/materialized-reports/materialized-dinein-compile-helpers.js +500 -0
- package/esm/helpers/materialized-reports/materialized-dinein-entry-pages.js +218 -0
- package/esm/helpers/materialized-reports/materialized-dinein-key-helpers.js +87 -0
- package/esm/helpers/materialized-reports/materialized-index-bootstrap.js +4 -0
- package/esm/helpers/materialized-reports/materialized-report-drilldown-rows.js +8 -0
- package/esm/helpers/materialized-reports/report-platform/definition.js +93 -1
- package/esm/helpers/materialized-reports/tenant-dinein-formatter.js +240 -0
- package/esm/helpers/reporting-contract/report-contract.js +3 -0
- package/esm/schemas/models/index.js +2 -0
- package/esm/schemas/models/materialized_tenant_dinein_entries.js +57 -0
- package/esm/schemas/models/materialized_tenant_dinein_reports.js +73 -0
- package/esm/schemas/types/index.js +2 -0
- package/esm/schemas/types/materialized_report_drilldown_rows.js +1 -0
- package/esm/schemas/types/materialized_tenant_dinein_entries.js +1 -0
- package/esm/schemas/types/materialized_tenant_dinein_reports.js +6 -0
- package/lib/constants/MATERIALIZED_REPORTS.d.ts +160 -8
- package/lib/constants/MATERIALIZED_REPORTS.js +178 -9
- package/lib/helpers/materialized-reports/index.d.ts +7 -0
- package/lib/helpers/materialized-reports/index.js +7 -0
- package/lib/helpers/materialized-reports/materialized-day-readiness.d.ts +1 -1
- package/lib/helpers/materialized-reports/materialized-day-readiness.js +2 -2
- package/lib/helpers/materialized-reports/materialized-dinein-accumulator-helpers.d.ts +67 -0
- package/lib/helpers/materialized-reports/materialized-dinein-accumulator-helpers.js +582 -0
- package/lib/helpers/materialized-reports/materialized-dinein-classification-helpers.d.ts +245 -0
- package/lib/helpers/materialized-reports/materialized-dinein-classification-helpers.js +469 -0
- package/lib/helpers/materialized-reports/materialized-dinein-close-day-helpers.d.ts +110 -0
- package/lib/helpers/materialized-reports/materialized-dinein-close-day-helpers.js +384 -0
- package/lib/helpers/materialized-reports/materialized-dinein-compile-helpers.d.ts +73 -0
- package/lib/helpers/materialized-reports/materialized-dinein-compile-helpers.js +504 -0
- package/lib/helpers/materialized-reports/materialized-dinein-entry-pages.d.ts +69 -0
- package/lib/helpers/materialized-reports/materialized-dinein-entry-pages.js +231 -0
- package/lib/helpers/materialized-reports/materialized-dinein-key-helpers.d.ts +44 -0
- package/lib/helpers/materialized-reports/materialized-dinein-key-helpers.js +96 -0
- package/lib/helpers/materialized-reports/materialized-index-bootstrap.js +4 -0
- package/lib/helpers/materialized-reports/materialized-report-drilldown-rows.js +8 -0
- package/lib/helpers/materialized-reports/report-platform/definition.js +92 -0
- package/lib/helpers/materialized-reports/tenant-dinein-formatter.d.ts +225 -0
- package/lib/helpers/materialized-reports/tenant-dinein-formatter.js +243 -0
- package/lib/helpers/reporting-contract/report-contract.d.ts +1 -0
- package/lib/helpers/reporting-contract/report-contract.js +3 -0
- package/lib/schemas/models/index.d.ts +2 -0
- package/lib/schemas/models/index.js +2 -0
- package/lib/schemas/models/materialized_tenant_day_readiness.d.ts +3 -3
- package/lib/schemas/models/materialized_tenant_dinein_entries.d.ts +100 -0
- package/lib/schemas/models/materialized_tenant_dinein_entries.js +60 -0
- package/lib/schemas/models/materialized_tenant_dinein_reports.d.ts +111 -0
- package/lib/schemas/models/materialized_tenant_dinein_reports.js +76 -0
- package/lib/schemas/types/index.d.ts +2 -0
- package/lib/schemas/types/index.js +2 -0
- package/lib/schemas/types/materialized_report_drilldown_rows.d.ts +1 -1
- package/lib/schemas/types/materialized_report_drilldown_rows.js +1 -0
- package/lib/schemas/types/materialized_tenant_dinein_entries.d.ts +127 -0
- package/lib/schemas/types/materialized_tenant_dinein_entries.js +2 -0
- package/lib/schemas/types/materialized_tenant_dinein_reports.d.ts +326 -0
- package/lib/schemas/types/materialized_tenant_dinein_reports.js +9 -0
- package/lib/tests/materialized-reports/dinein-fixtures.d.ts +29 -0
- package/lib/tests/materialized-reports/dinein-fixtures.js +130 -0
- package/lib/tests/materialized-reports/materialized-day-readiness.test.js +3 -2
- package/lib/tests/materialized-reports/materialized-dinein-compile.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-dinein-compile.test.js +807 -0
- package/lib/tests/materialized-reports/materialized-dinein-plan.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-dinein-plan.test.js +419 -0
- package/lib/tests/materialized-reports/materialized-tenant-dinein-schema.test.d.ts +1 -0
- package/lib/tests/materialized-reports/materialized-tenant-dinein-schema.test.js +185 -0
- package/lib/tests/materialized-reports/report-platform/registry-conformance.test.js +15 -2
- package/lib/tests/materialized-reports/tenant-dinein-formatter.test.d.ts +1 -0
- package/lib/tests/materialized-reports/tenant-dinein-formatter.test.js +299 -0
- package/package.json +1 -1
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
13
|
exports.MATERIALIZED_DELIVERY_GEO_SCOPES = exports.MATERIALIZED_DELIVERY_GEO_RESOLUTION = exports.MATERIALIZED_DELIVERY_GEO_MAX_KEYS = exports.MATERIALIZED_TENANT_DELIVERY_GEO_SCOPES_SCHEMA_VERSION = exports.MATERIALIZED_TENANT_DELIVERY_GEO_SCOPES_COLLECTION_NAME = exports.MATERIALIZED_TENANT_DELIVERY_GEO_CELLS_SCHEMA_VERSION = exports.MATERIALIZED_DELIVERY_OTHER_TOKEN = exports.MATERIALIZED_DELIVERY_AREA_LIMIT = exports.MATERIALIZED_DELIVERY_RIDER_LIMIT = exports.MATERIALIZED_DELIVERY_DISTANCE_BUCKETS = exports.DELIVERY_KEY_FILTERS = exports.MATERIALIZED_DELIVERY_ENTRY_PAGE_ALL = exports.MATERIALIZED_DELIVERY_ENTRY_SCOPES = exports.MATERIALIZED_DELIVERY_REPORT_SCOPES = exports.MATERIALIZED_CASH_SOURCE_LIMIT = exports.CASH_KEY_FILTERS = exports.MATERIALIZED_CASH_REPORT_SCOPES = exports.ALL_MATERIALIZED_REPORT_CREDIT_BILL_EVENT_TYPES = exports.MATERIALIZED_REPORT_CREDIT_BILL_EVENT_TYPE_ENUM = exports.MATERIALIZED_CREDIT_SETTLEMENT_PAYMENT_TYPE = exports.MATERIALIZED_DISCOUNT_SOURCE_KEY_PREFIX = exports.MATERIALIZED_DISCOUNT_SOURCE_KEY = exports.ALL_MATERIALIZED_DISCOUNT_RATE_KINDS = exports.MATERIALIZED_DISCOUNT_RATE_KIND_ENUM = exports.ALL_MATERIALIZED_DISCOUNT_SOURCE_CLASSES = exports.MATERIALIZED_DISCOUNT_SOURCE_CLASS_ENUM = exports.MATERIALIZED_DISCOUNT_PRICE_OVERRIDE_PREFIX = exports.MATERIALIZED_DISCOUNT_MANUAL_PREFIX = exports.MATERIALIZED_DISCOUNT_SPECIAL_DISCOUNT_ID = exports.MATERIALIZED_DISCOUNT_SOURCE_LIMIT = exports.ALL_MATERIALIZED_DISCOUNT_LEVELS = exports.MATERIALIZED_DISCOUNT_LEVEL_ENUM = exports.ALL_MATERIALIZED_DISCOUNT_ENTRY_KINDS = exports.MATERIALIZED_DISCOUNT_ENTRY_KIND_ENUM = exports.ALL_MATERIALIZED_DISCOUNT_SUB_KINDS = exports.MATERIALIZED_DISCOUNT_SUB_KIND_ENUM = exports.ALL_MATERIALIZED_DISCOUNT_SLOTS = exports.MATERIALIZED_DISCOUNT_SLOT_ENUM = exports.DISCOUNTS_KEY_FILTERS = exports.MATERIALIZED_DISCOUNT_REPORT_SCOPES = exports.MATERIALIZED_DISCOUNT_ENTRY_PAGE_ALL = exports.SALES_OVERVIEW_KEY_FILTERS = exports.ALL_MATERIALIZED_REPORT_KEY_FILTERS = exports.MATERIALIZED_REPORT_KEY_FILTER_ENUM = exports.MATERIALIZED_CREDIT_BILLS_SCOPES = exports.MATERIALIZED_REPORT_SCOPES_WITH_DAY_INDEX = exports.ALL_MATERIALIZED_REPORT_WINDOW_KINDS = exports.MATERIALIZED_REPORT_WINDOW_KIND_ENUM = exports.ALL_MATERIALIZED_REPORT_SCOPES = exports.MATERIALIZED_REPORT_SCOPE_ENUM = void 0;
|
|
14
14
|
exports.MATERIALIZED_DIALER_ENTRY_PAGE_ALL = exports.MATERIALIZED_DIALER_ENTRY_SCOPES = exports.MATERIALIZED_DIALER_REPORT_SCOPES = exports.ALL_PAYMENTS_COMPARISON_METRICS = exports.PAYMENTS_COMPARISON_METRIC_ENUM = exports.MATERIALIZED_TENANT_PAYMENTS_COMPARISON_ENTRIES_SCHEMA_VERSION = exports.MATERIALIZED_TENANT_PAYMENTS_COMPARISON_REPORTS_SCHEMA_VERSION = exports.PAYMENTS_COMPARISON_KEY_FILTERS = exports.MATERIALIZED_PAYMENTS_COMPARISON_REPORT_SCOPES = exports.MATERIALIZED_TENANT_PAYMENTS_COMPARISON_ENTRIES_COLLECTION_NAME = exports.MATERIALIZED_TENANT_PAYMENTS_COMPARISON_REPORTS_COLLECTION_NAME = exports.MATERIALIZED_TENANT_HOURLY_COMPARISON_ENTRIES_SCHEMA_VERSION = exports.MATERIALIZED_TENANT_HOURLY_COMPARISON_REPORTS_SCHEMA_VERSION = exports.HOURLY_COMPARISON_KEY_FILTERS = exports.MATERIALIZED_HOURLY_COMPARISON_REPORT_SCOPES = exports.MATERIALIZED_TENANT_HOURLY_COMPARISON_ENTRIES_COLLECTION_NAME = exports.MATERIALIZED_TENANT_HOURLY_COMPARISON_REPORTS_COLLECTION_NAME = exports.ALL_SALES_COMPARISON_METRICS = exports.SALES_COMPARISON_METRIC_ENUM = exports.ALL_SALES_COMPARISON_BASELINES = exports.SALES_COMPARISON_BASELINE_ENUM = exports.MATERIALIZED_TENANT_SALES_COMPARISON_ENTRIES_SCHEMA_VERSION = exports.MATERIALIZED_TENANT_SALES_COMPARISON_REPORTS_SCHEMA_VERSION = exports.SALES_COMPARISON_KEY_FILTERS = exports.MATERIALIZED_SALES_COMPARISON_REPORT_SCOPES = exports.MATERIALIZED_TENANT_SALES_COMPARISON_ENTRIES_COLLECTION_NAME = exports.MATERIALIZED_TENANT_SALES_COMPARISON_REPORTS_COLLECTION_NAME = exports.ALL_MATERIALIZED_REPORT_TYPES = exports.MATERIALIZED_REPORT_TYPE_ENUM = exports.ALL_MATERIALIZED_PREP_TIME_TARGETS = exports.MATERIALIZED_PREP_TIME_TARGET_ENUM = exports.MATERIALIZED_PREP_TIME_ON_TIME_MAX_DELTA = exports.MATERIALIZED_PREP_TIME_TOP_BUCKET = exports.MATERIALIZED_PREP_TIME_MAX_MINUTES = exports.ALL_MATERIALIZED_PREP_TIME_BUCKET_LABELS = exports.MATERIALIZED_PREP_TIME_BUCKETS = exports.ALL_MATERIALIZED_PREP_TIME_ANCHORS = exports.MATERIALIZED_PREP_TIME_ANCHOR_ENUM = exports.PREP_TIME_KEY_FILTERS = exports.MATERIALIZED_PREP_TIME_ITEM_MAX_READ_DAYS = exports.MATERIALIZED_PREP_TIME_ITEM_SCOPES = exports.MATERIALIZED_PREP_TIME_REPORT_SCOPES = exports.MATERIALIZED_DELIVERY_GEO_CELL_MAX_BSON_BYTES = exports.MATERIALIZED_DELIVERY_ENTRY_MAX_BSON_BYTES = exports.MATERIALIZED_DELIVERY_REPORT_MAX_BSON_BYTES = exports.MATERIALIZED_DELIVERY_GEO_UNKNOWN_CELL = exports.MATERIALIZED_DELIVERY_GEO_MONTH_RETENTION_MONTHS = exports.MATERIALIZED_DELIVERY_GEO_DAY_RETENTION_DAYS = exports.MATERIALIZED_DELIVERY_GEO_MAX_CELLS = exports.MATERIALIZED_DELIVERY_GEO_MIN_ORDERS = void 0;
|
|
15
|
-
exports.
|
|
15
|
+
exports.MATERIALIZED_READINESS_REPORT_KEYS = exports.ALL_MATERIALIZED_REPORT_READINESS_STATUSES = exports.MATERIALIZED_REPORT_READINESS_STATUS_ENUM = exports.MATERIALIZED_TENANT_DAY_READINESS_SCHEMA_VERSION = exports.MATERIALIZED_TENANT_DAY_READINESS_COLLECTION_NAME = exports.MATERIALIZED_DINEIN_RESERVATIONS_TIME_INDEX_OPTIONS = exports.MATERIALIZED_DINEIN_FINGERPRINTS_CREATED_AT_INDEX_OPTIONS = exports.MATERIALIZED_DINEIN_FINGERPRINTS_ORDER_INDEX_OPTIONS = exports.MATERIALIZED_DINEIN_ENTRY_MAX_BSON_BYTES = exports.MATERIALIZED_DINEIN_REPORT_MAX_BSON_BYTES = exports.ALL_MATERIALIZED_DINEIN_PAYMENT_CLASSES = exports.MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM = exports.ALL_MATERIALIZED_DINEIN_SPLIT_ROLES = exports.MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM = exports.ALL_MATERIALIZED_DINEIN_ORIGINS = exports.MATERIALIZED_DINEIN_ORIGIN_ENUM = exports.MATERIALIZED_DINEIN_SPLIT_PARENT_DELETE_REASON = exports.MATERIALIZED_DINEIN_HOUR_KEYS = exports.MATERIALIZED_DINEIN_TOP_EDITED_CHECK_LIMIT = exports.MATERIALIZED_DINEIN_UPCOMING_RESERVATION_LIMIT = exports.MATERIALIZED_DINEIN_SERVICE_CHARGE_RATE_LIMIT = exports.MATERIALIZED_DINEIN_COURSE_LIMIT = exports.MATERIALIZED_DINEIN_FLOOR_LIMIT = exports.MATERIALIZED_DINEIN_TABLE_LIMIT = exports.MATERIALIZED_DINEIN_OTHER_TOKEN = exports.MATERIALIZED_DINEIN_KEY_SEPARATOR = exports.MATERIALIZED_DINEIN_UNKNOWN_TOKEN = exports.DINEIN_KEY_FILTERS = exports.MATERIALIZED_DINEIN_ENTRY_PAGE_ALL = exports.MATERIALIZED_DINEIN_ENTRY_SCOPES = exports.MATERIALIZED_DINEIN_REPORT_SCOPES = exports.MATERIALIZED_DIALER_ENTRY_MAX_BSON_BYTES = exports.MATERIALIZED_DIALER_REPORT_MAX_BSON_BYTES = exports.MATERIALIZED_DIALER_HOUR_KEYS = exports.MATERIALIZED_DIALER_KEY_SEPARATOR = exports.MATERIALIZED_DIALER_UNKNOWN_TOKEN = exports.DIALER_KEY_FILTERS = void 0;
|
|
16
16
|
/**
|
|
17
17
|
* Time-scope of a materialized report document. Every document covers exactly
|
|
18
18
|
* one tenant × one scope context × one scope value (`scope_field`), and the
|
|
@@ -687,6 +687,8 @@ var MATERIALIZED_REPORT_TYPE_ENUM;
|
|
|
687
687
|
MATERIALIZED_REPORT_TYPE_ENUM["TENANT_PAYMENTS_COMPARISON_ENTRIES"] = "TENANT_PAYMENTS_COMPARISON_ENTRIES";
|
|
688
688
|
MATERIALIZED_REPORT_TYPE_ENUM["TENANT_DIALER_REPORTS"] = "TENANT_DIALER_REPORTS";
|
|
689
689
|
MATERIALIZED_REPORT_TYPE_ENUM["TENANT_DIALER_ENTRIES"] = "TENANT_DIALER_ENTRIES";
|
|
690
|
+
MATERIALIZED_REPORT_TYPE_ENUM["TENANT_DINEIN_REPORTS"] = "TENANT_DINEIN_REPORTS";
|
|
691
|
+
MATERIALIZED_REPORT_TYPE_ENUM["TENANT_DINEIN_ENTRIES"] = "TENANT_DINEIN_ENTRIES";
|
|
690
692
|
})(MATERIALIZED_REPORT_TYPE_ENUM || (exports.MATERIALIZED_REPORT_TYPE_ENUM = MATERIALIZED_REPORT_TYPE_ENUM = {}));
|
|
691
693
|
exports.ALL_MATERIALIZED_REPORT_TYPES = Object.values(MATERIALIZED_REPORT_TYPE_ENUM);
|
|
692
694
|
/* =====================> Sales Comparison report <===================== */
|
|
@@ -904,11 +906,175 @@ exports.MATERIALIZED_DIALER_HOUR_KEYS = Array.from({ length: 24 }, (_, hour) =>
|
|
|
904
906
|
exports.MATERIALIZED_DIALER_REPORT_MAX_BSON_BYTES = 15 * 1024 * 1024;
|
|
905
907
|
exports.MATERIALIZED_DIALER_ENTRY_MAX_BSON_BYTES = 15 * 1024 * 1024;
|
|
906
908
|
/* ======================================================================== */
|
|
907
|
-
/*
|
|
909
|
+
/* Dinein report (M5) */
|
|
908
910
|
/* ======================================================================== */
|
|
909
911
|
/**
|
|
910
|
-
*
|
|
911
|
-
*
|
|
912
|
+
* The Dinein report: covers, checks, seated occupancy, courses, split bills,
|
|
913
|
+
* reservations and guest experience for the dine-in population.
|
|
914
|
+
*
|
|
915
|
+
* ## Population
|
|
916
|
+
*
|
|
917
|
+
* `orders` with `dinein_details != null` for the order's OWN `localDate`. The
|
|
918
|
+
* deleted split PARENT is excluded from sales/order counts (the children are the
|
|
919
|
+
* collectable checks) and is read only for rating/review discovery.
|
|
920
|
+
*
|
|
921
|
+
* ## Two collections, one report
|
|
922
|
+
*
|
|
923
|
+
* `materialized_tenant_dinein_reports` is COUNTERS ONLY, keyed by
|
|
924
|
+
* `<ORDER_STATUS>:<PLATFORM>` (`sale_type_key_filters`); the reservation block is
|
|
925
|
+
* day-level because a reservation has no order and must never be dropped by an
|
|
926
|
+
* order-status/platform filter. `materialized_tenant_dinein_entries` holds ONE
|
|
927
|
+
* PAGE per source day (the discounts/delivery/dialer page model).
|
|
928
|
+
*/
|
|
929
|
+
/**
|
|
930
|
+
* The two collections are named/versioned by their model modules
|
|
931
|
+
* (`materialized_tenant_dinein_reports` / `..._entries`), exactly like the other
|
|
932
|
+
* materialized report collections.
|
|
933
|
+
*/
|
|
934
|
+
/**
|
|
935
|
+
* Scopes materialized by `materialized_tenant_dinein_reports`.
|
|
936
|
+
*
|
|
937
|
+
* NO `localHour`: the hour dimension is the `by_hour` map inside the document
|
|
938
|
+
* (the sales/covers-by-hour chart), exactly like Delivery. `localDate` is the day
|
|
939
|
+
* the ORDER was sold on (`order.localDate`), never the fingerprint's creation
|
|
940
|
+
* day: a table can close after midnight and still belong to the day it was sold.
|
|
941
|
+
*/
|
|
942
|
+
exports.MATERIALIZED_DINEIN_REPORT_SCOPES = [
|
|
943
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_DATE,
|
|
944
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_WEEK,
|
|
945
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_WEEK_OF_YEAR,
|
|
946
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
|
|
947
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_QUARTER,
|
|
948
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_SEMESTER,
|
|
949
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_YEAR,
|
|
950
|
+
];
|
|
951
|
+
/**
|
|
952
|
+
* Entry scopes. A PERIOD entry document is PAGE-PARTITIONED by source day
|
|
953
|
+
* (`page = <source localDate>`) so a document is bounded by ONE day's checks; a
|
|
954
|
+
* month is covered by its 28-31 pages. There is no quarter/semester/year entry
|
|
955
|
+
* document, and a broad details selection is served from the month pages it
|
|
956
|
+
* touches (never refused).
|
|
957
|
+
*/
|
|
958
|
+
exports.MATERIALIZED_DINEIN_ENTRY_SCOPES = [
|
|
959
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_DATE,
|
|
960
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_WEEK,
|
|
961
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_WEEK_OF_YEAR,
|
|
962
|
+
MATERIALIZED_REPORT_SCOPE_ENUM.LOCAL_MONTH,
|
|
963
|
+
];
|
|
964
|
+
/** Page key of the DAY-scoped entry document (the day scope is already one day). */
|
|
965
|
+
exports.MATERIALIZED_DINEIN_ENTRY_PAGE_ALL = 'all';
|
|
966
|
+
/**
|
|
967
|
+
* Ordered key filters of the dinein report (`COMPLETED:POS_DINE-IN`) — the SAME
|
|
968
|
+
* two dimensions every order-shaped materialized counter document declares. They
|
|
969
|
+
* are the only filters the SUMMARY can apply exactly, because they are the key
|
|
970
|
+
* grammar; origin / table / floor / split / offline are ROW filters and are
|
|
971
|
+
* declared `appliesTo: DETAILS` (a summary request that sends one is REJECTED,
|
|
972
|
+
* never silently answered unfiltered).
|
|
973
|
+
*/
|
|
974
|
+
exports.DINEIN_KEY_FILTERS = [
|
|
975
|
+
MATERIALIZED_REPORT_KEY_FILTER_ENUM.ORDER_STATUS,
|
|
976
|
+
MATERIALIZED_REPORT_KEY_FILTER_ENUM.PLATFORM,
|
|
977
|
+
];
|
|
978
|
+
/** Token for a missing key/row dimension. A missing dimension is never dropped. */
|
|
979
|
+
exports.MATERIALIZED_DINEIN_UNKNOWN_TOKEN = 'UNKNOWN';
|
|
980
|
+
/** Key-component separator (`<ORDER_STATUS>:<PLATFORM>`). */
|
|
981
|
+
exports.MATERIALIZED_DINEIN_KEY_SEPARATOR = ':';
|
|
982
|
+
/**
|
|
983
|
+
* Token of the ONE overflow row every BOUNDED map keeps after its top-N
|
|
984
|
+
* (tables / floors / courses / service-charge rates), so a capped map still
|
|
985
|
+
* reconciles against the document totals instead of silently dropping rows.
|
|
986
|
+
*/
|
|
987
|
+
exports.MATERIALIZED_DINEIN_OTHER_TOKEN = '__OTHER__';
|
|
988
|
+
/** Per-document caps of the bounded maps (ranked `key ASC` after the metric). */
|
|
989
|
+
exports.MATERIALIZED_DINEIN_TABLE_LIMIT = 200;
|
|
990
|
+
exports.MATERIALIZED_DINEIN_FLOOR_LIMIT = 50;
|
|
991
|
+
exports.MATERIALIZED_DINEIN_COURSE_LIMIT = 50;
|
|
992
|
+
exports.MATERIALIZED_DINEIN_SERVICE_CHARGE_RATE_LIMIT = 50;
|
|
993
|
+
/**
|
|
994
|
+
* Caps of the two BOUNDED SUMMARY SNAPSHOTS.
|
|
995
|
+
*
|
|
996
|
+
* `upcoming_reservations` and `top_edited_checks` are display-only tables, not a
|
|
997
|
+
* second pagination source (the Orders tab always uses the cursor read). The DAY
|
|
998
|
+
* document keeps its own top-N; a PERIOD document re-ranks the union of its day
|
|
999
|
+
* documents' snapshots and keeps top-N again, so a month cannot grow the arrays.
|
|
1000
|
+
*/
|
|
1001
|
+
exports.MATERIALIZED_DINEIN_UPCOMING_RESERVATION_LIMIT = 10;
|
|
1002
|
+
exports.MATERIALIZED_DINEIN_TOP_EDITED_CHECK_LIMIT = 10;
|
|
1003
|
+
/** The 24 hour keys of `by_hour`, initialized to 0 so absence is unambiguously zero. */
|
|
1004
|
+
exports.MATERIALIZED_DINEIN_HOUR_KEYS = Array.from({ length: 24 }, (_, hour) => String(hour));
|
|
1005
|
+
/**
|
|
1006
|
+
* `delete_reason` of a split parent that was auto-deleted by the split flow.
|
|
1007
|
+
*
|
|
1008
|
+
* The parent still carries the rating/review of the visit but is NOT a
|
|
1009
|
+
* collectable check: it never contributes sales or an order count.
|
|
1010
|
+
*/
|
|
1011
|
+
exports.MATERIALIZED_DINEIN_SPLIT_PARENT_DELETE_REASON = 'Auto Deleted on Split';
|
|
1012
|
+
/**
|
|
1013
|
+
* Where the first version of a check was taken. Derived from the OLDEST
|
|
1014
|
+
* iteration (or the current order when it has none) — see
|
|
1015
|
+
* `classifyMaterializedDineinOrigin`.
|
|
1016
|
+
*/
|
|
1017
|
+
var MATERIALIZED_DINEIN_ORIGIN_ENUM;
|
|
1018
|
+
(function (MATERIALIZED_DINEIN_ORIGIN_ENUM) {
|
|
1019
|
+
/** `POS_DINE-IN` — a terminal the guest ordered at. */
|
|
1020
|
+
MATERIALIZED_DINEIN_ORIGIN_ENUM["POS_DIRECT"] = "POS_DIRECT";
|
|
1021
|
+
/** `APP_DINE-IN` / `WEB_DINE-IN` WITH a staff or order-taker — a staff tablet. */
|
|
1022
|
+
MATERIALIZED_DINEIN_ORIGIN_ENUM["STAFF_TABLET"] = "STAFF_TABLET";
|
|
1023
|
+
/** `APP_DINE-IN` / `WEB_DINE-IN`, no staff, but a consumer phone — QR self-order. */
|
|
1024
|
+
MATERIALIZED_DINEIN_ORIGIN_ENUM["QR_SELF_ORDER"] = "QR_SELF_ORDER";
|
|
1025
|
+
/** Anything else. Never invented into one of the three real origins. */
|
|
1026
|
+
MATERIALIZED_DINEIN_ORIGIN_ENUM["UNKNOWN_ORIGIN"] = "UNKNOWN_ORIGIN";
|
|
1027
|
+
})(MATERIALIZED_DINEIN_ORIGIN_ENUM || (exports.MATERIALIZED_DINEIN_ORIGIN_ENUM = MATERIALIZED_DINEIN_ORIGIN_ENUM = {}));
|
|
1028
|
+
exports.ALL_MATERIALIZED_DINEIN_ORIGINS = Object.values(MATERIALIZED_DINEIN_ORIGIN_ENUM);
|
|
1029
|
+
/** The role a counted check plays in a split bill. The parent never appears as a row. */
|
|
1030
|
+
var MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM;
|
|
1031
|
+
(function (MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM) {
|
|
1032
|
+
MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM["NONE"] = "NONE";
|
|
1033
|
+
MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM["CHILD"] = "CHILD";
|
|
1034
|
+
})(MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM || (exports.MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM = MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM = {}));
|
|
1035
|
+
exports.ALL_MATERIALIZED_DINEIN_SPLIT_ROLES = Object.values(MATERIALIZED_DINEIN_SPLIT_ROLE_ENUM);
|
|
1036
|
+
/** Payment classification used by `card_amount` / `cash_amount` / `other_amount`. */
|
|
1037
|
+
var MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM;
|
|
1038
|
+
(function (MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM) {
|
|
1039
|
+
MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM["CASH"] = "CASH";
|
|
1040
|
+
MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM["CARD"] = "CARD";
|
|
1041
|
+
MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM["OTHER"] = "OTHER";
|
|
1042
|
+
})(MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM || (exports.MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM = MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM = {}));
|
|
1043
|
+
exports.ALL_MATERIALIZED_DINEIN_PAYMENT_CLASSES = Object.values(MATERIALIZED_DINEIN_PAYMENT_CLASS_ENUM);
|
|
1044
|
+
/**
|
|
1045
|
+
* Per-collection BSON budgets (bytes). MongoDB's hard limit is 16 MiB per
|
|
1046
|
+
* document; 15 MiB is the owner-approved practical ceiling for the dinein
|
|
1047
|
+
* report and each entry page (same as Delivery/Dialer). A writer that exceeds
|
|
1048
|
+
* its budget fails at COMPILE/PLAN time with the collection + day + scope in the
|
|
1049
|
+
* message — never midway through the close transaction with a server-side
|
|
1050
|
+
* "object too large" error.
|
|
1051
|
+
*/
|
|
1052
|
+
exports.MATERIALIZED_DINEIN_REPORT_MAX_BSON_BYTES = 15 * 1024 * 1024;
|
|
1053
|
+
exports.MATERIALIZED_DINEIN_ENTRY_MAX_BSON_BYTES = 15 * 1024 * 1024;
|
|
1054
|
+
/**
|
|
1055
|
+
* SOURCE-collection indexes the Dinein writer needs, DECLARED ONLY.
|
|
1056
|
+
*
|
|
1057
|
+
* The services run with `autoIndex: false`; nothing here is applied at runtime.
|
|
1058
|
+
* `dinein_tables_fingerprints` is queried by the day's order ids (session join)
|
|
1059
|
+
* and by `createdAt` (the table-close event scan); `reservations` is queried by
|
|
1060
|
+
* the tenant-local `reservation_time` day. Creating these indexes is an OWNER
|
|
1061
|
+
* deploy step (see the operations index plan).
|
|
1062
|
+
*/
|
|
1063
|
+
exports.MATERIALIZED_DINEIN_FINGERPRINTS_ORDER_INDEX_OPTIONS = [
|
|
1064
|
+
{ key: { tenant_id: 1, order_id: 1 }, name: 'tenant_id__order_id' },
|
|
1065
|
+
];
|
|
1066
|
+
exports.MATERIALIZED_DINEIN_FINGERPRINTS_CREATED_AT_INDEX_OPTIONS = [
|
|
1067
|
+
{ key: { tenant_id: 1, createdAt: -1 }, name: 'tenant_id__createdAt' },
|
|
1068
|
+
];
|
|
1069
|
+
exports.MATERIALIZED_DINEIN_RESERVATIONS_TIME_INDEX_OPTIONS = [
|
|
1070
|
+
{ key: { tenant_id: 1, reservation_time: 1 }, name: 'tenant_id__reservation_time' },
|
|
1071
|
+
];
|
|
1072
|
+
/* ======================================================================== */
|
|
1073
|
+
/* Day readiness (six production writers) */
|
|
1074
|
+
/* ======================================================================== */
|
|
1075
|
+
/**
|
|
1076
|
+
* COMMITTED-READINESS ledger for the SIX reports written by END_TENANT_DAY and
|
|
1077
|
+
* the range sync: Overview, Discounts, Prep Time, Delivery, Dialer and Dinein.
|
|
912
1078
|
*
|
|
913
1079
|
* One row per (tenant_id, localDate, report_key, schema_version). The row is
|
|
914
1080
|
* written in the SAME transaction/session as the report documents, so it can
|
|
@@ -943,8 +1109,11 @@ exports.ALL_MATERIALIZED_REPORT_READINESS_STATUSES = Object.values(MATERIALIZED_
|
|
|
943
1109
|
* The ONLY reports that own a readiness row. Adding another report here means
|
|
944
1110
|
* giving it a writer that participates in the same day transaction.
|
|
945
1111
|
*/
|
|
946
|
-
exports.MATERIALIZED_READINESS_REPORT_KEYS = [
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
1112
|
+
exports.MATERIALIZED_READINESS_REPORT_KEYS = [
|
|
1113
|
+
'OVERVIEW',
|
|
1114
|
+
'DISCOUNTS',
|
|
1115
|
+
'PREP_TIME',
|
|
1116
|
+
'DELIVERY',
|
|
1117
|
+
'DIALER',
|
|
1118
|
+
'DINEIN',
|
|
1119
|
+
];
|
|
@@ -31,6 +31,12 @@ export * from './materialized-dialer-compile-helpers';
|
|
|
31
31
|
export * from './materialized-dialer-entry-pages';
|
|
32
32
|
export * from './materialized-dialer-key-helpers';
|
|
33
33
|
export * from './materialized-dialer-masking';
|
|
34
|
+
export * from './materialized-dinein-accumulator-helpers';
|
|
35
|
+
export * from './materialized-dinein-classification-helpers';
|
|
36
|
+
export * from './materialized-dinein-close-day-helpers';
|
|
37
|
+
export * from './materialized-dinein-compile-helpers';
|
|
38
|
+
export * from './materialized-dinein-entry-pages';
|
|
39
|
+
export * from './materialized-dinein-key-helpers';
|
|
34
40
|
export * from './materialized-day-input-signature';
|
|
35
41
|
export * from './materialized-cash-classification-helpers';
|
|
36
42
|
export * from './materialized-cash-close-day-helpers';
|
|
@@ -58,6 +64,7 @@ export * from './tenant-discount-source-formatter';
|
|
|
58
64
|
export * from './tenant-cash-in-out-formatter';
|
|
59
65
|
export * from './tenant-delivery-formatter';
|
|
60
66
|
export * from './tenant-dialer-formatter';
|
|
67
|
+
export * from './tenant-dinein-formatter';
|
|
61
68
|
export * from './tenant-prep-time-formatter';
|
|
62
69
|
export * from './tenant-sales-overview-formatter';
|
|
63
70
|
export * from './tenant-sales-overview-helpers';
|
|
@@ -47,6 +47,12 @@ __exportStar(require("./materialized-dialer-compile-helpers"), exports);
|
|
|
47
47
|
__exportStar(require("./materialized-dialer-entry-pages"), exports);
|
|
48
48
|
__exportStar(require("./materialized-dialer-key-helpers"), exports);
|
|
49
49
|
__exportStar(require("./materialized-dialer-masking"), exports);
|
|
50
|
+
__exportStar(require("./materialized-dinein-accumulator-helpers"), exports);
|
|
51
|
+
__exportStar(require("./materialized-dinein-classification-helpers"), exports);
|
|
52
|
+
__exportStar(require("./materialized-dinein-close-day-helpers"), exports);
|
|
53
|
+
__exportStar(require("./materialized-dinein-compile-helpers"), exports);
|
|
54
|
+
__exportStar(require("./materialized-dinein-entry-pages"), exports);
|
|
55
|
+
__exportStar(require("./materialized-dinein-key-helpers"), exports);
|
|
50
56
|
__exportStar(require("./materialized-day-input-signature"), exports);
|
|
51
57
|
__exportStar(require("./materialized-cash-classification-helpers"), exports);
|
|
52
58
|
__exportStar(require("./materialized-cash-close-day-helpers"), exports);
|
|
@@ -74,6 +80,7 @@ __exportStar(require("./tenant-discount-source-formatter"), exports);
|
|
|
74
80
|
__exportStar(require("./tenant-cash-in-out-formatter"), exports);
|
|
75
81
|
__exportStar(require("./tenant-delivery-formatter"), exports);
|
|
76
82
|
__exportStar(require("./tenant-dialer-formatter"), exports);
|
|
83
|
+
__exportStar(require("./tenant-dinein-formatter"), exports);
|
|
77
84
|
__exportStar(require("./tenant-prep-time-formatter"), exports);
|
|
78
85
|
__exportStar(require("./tenant-sales-overview-formatter"), exports);
|
|
79
86
|
__exportStar(require("./tenant-sales-overview-helpers"), exports);
|
|
@@ -33,7 +33,7 @@ export interface IMaterializedDayReadinessGaps {
|
|
|
33
33
|
/** Exact pairs awaiting reconciliation (for logs / diagnostics). */
|
|
34
34
|
needs_reconciliation_pairs: IMaterializedDayReadinessPair[];
|
|
35
35
|
}
|
|
36
|
-
/** Whether `report` is one of the
|
|
36
|
+
/** Whether `report` is one of the SIX reports that own readiness rows. */
|
|
37
37
|
export declare function isMaterializedReadinessReportKey(report: string): boolean;
|
|
38
38
|
/**
|
|
39
39
|
* The readiness doc identity key. Kept as a string so the same helper can index
|
|
@@ -6,7 +6,7 @@ exports.summarizeMaterializedDayReadiness = summarizeMaterializedDayReadiness;
|
|
|
6
6
|
exports.buildMaterializedDayReadinessDocument = buildMaterializedDayReadinessDocument;
|
|
7
7
|
const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
|
|
8
8
|
const uniqueSorted = (values) => [...new Set(values)].sort();
|
|
9
|
-
/** Whether `report` is one of the
|
|
9
|
+
/** Whether `report` is one of the SIX reports that own readiness rows. */
|
|
10
10
|
function isMaterializedReadinessReportKey(report) {
|
|
11
11
|
return MATERIALIZED_REPORTS_1.MATERIALIZED_READINESS_REPORT_KEYS.includes(report);
|
|
12
12
|
}
|
|
@@ -86,7 +86,7 @@ function buildMaterializedDayReadinessDocument(input) {
|
|
|
86
86
|
if (!isMaterializedReadinessReportKey(String(input.reportKey))) {
|
|
87
87
|
throw new Error('buildMaterializedDayReadinessDocument: report ' +
|
|
88
88
|
String(input.reportKey) +
|
|
89
|
-
' is outside the
|
|
89
|
+
' is outside the six report readiness contract');
|
|
90
90
|
}
|
|
91
91
|
return {
|
|
92
92
|
tenant_id: String(input.tenantId),
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { IMaterializedDineinBreakdownRow, IMaterializedDineinCounters, IMaterializedDineinCourseRow, IMaterializedDineinFloorRow, IMaterializedDineinHourRow, IMaterializedDineinOriginRow, IMaterializedDineinPaymentRow, IMaterializedDineinReservationCounters, IMaterializedDineinReservationHourRow, IMaterializedDineinTableRow, IMaterializedDineinTopEditedCheck, IMaterializedDineinUpcomingReservation } from '../../schemas/types/materialized_tenant_dinein_reports';
|
|
2
|
+
/** A zeroed hour row. */
|
|
3
|
+
export declare function emptyMaterializedDineinHourRow(): IMaterializedDineinHourRow;
|
|
4
|
+
/** Merges one hour row into another. */
|
|
5
|
+
export declare function mergeMaterializedDineinHourRow(target: IMaterializedDineinHourRow, source: IMaterializedDineinHourRow): void;
|
|
6
|
+
/** A zeroed table row. */
|
|
7
|
+
export declare function emptyMaterializedDineinTableRow(tableId?: string, tableName?: string, floorId?: string): IMaterializedDineinTableRow;
|
|
8
|
+
/** A zeroed floor row. */
|
|
9
|
+
export declare function emptyMaterializedDineinFloorRow(floorId?: string): IMaterializedDineinFloorRow;
|
|
10
|
+
/** A zeroed course row. */
|
|
11
|
+
export declare function emptyMaterializedDineinCourseRow(courseId: string, name: string): IMaterializedDineinCourseRow;
|
|
12
|
+
/** A zeroed origin row. */
|
|
13
|
+
export declare function emptyMaterializedDineinOriginRow(): IMaterializedDineinOriginRow;
|
|
14
|
+
/** A zeroed `by_status` / `by_platform` row. */
|
|
15
|
+
export declare function emptyMaterializedDineinBreakdownRow(): IMaterializedDineinBreakdownRow;
|
|
16
|
+
/** Merges one rich breakdown row into another. */
|
|
17
|
+
export declare function mergeMaterializedDineinBreakdownRow(target: IMaterializedDineinBreakdownRow, source: IMaterializedDineinBreakdownRow): void;
|
|
18
|
+
/** A zeroed reservation-hour row. */
|
|
19
|
+
export declare function emptyMaterializedDineinReservationHourRow(): IMaterializedDineinReservationHourRow;
|
|
20
|
+
/** Merges one reservation-hour row into another. */
|
|
21
|
+
export declare function mergeMaterializedDineinReservationHourRow(target: IMaterializedDineinReservationHourRow, source: IMaterializedDineinReservationHourRow): void;
|
|
22
|
+
/** A zeroed payment-type row. */
|
|
23
|
+
export declare function emptyMaterializedDineinPaymentRow(): IMaterializedDineinPaymentRow;
|
|
24
|
+
/** A zeroed reservation block. */
|
|
25
|
+
export declare function freshMaterializedDineinReservationCounters(): IMaterializedDineinReservationCounters;
|
|
26
|
+
/** A zeroed counter block, with every bounded map present. */
|
|
27
|
+
export declare function freshMaterializedDineinCounters(): IMaterializedDineinCounters;
|
|
28
|
+
/** Merges one table row into another (all counters additive). */
|
|
29
|
+
export declare function mergeMaterializedDineinTableRow(target: IMaterializedDineinTableRow, source: IMaterializedDineinTableRow): void;
|
|
30
|
+
/** Merges one floor row into another. */
|
|
31
|
+
export declare function mergeMaterializedDineinFloorRow(target: IMaterializedDineinFloorRow, source: IMaterializedDineinFloorRow): void;
|
|
32
|
+
/** Merges one course row into another. */
|
|
33
|
+
export declare function mergeMaterializedDineinCourseRow(target: IMaterializedDineinCourseRow, source: IMaterializedDineinCourseRow): void;
|
|
34
|
+
/** Merges one origin row into another. */
|
|
35
|
+
export declare function mergeMaterializedDineinOriginRow(target: IMaterializedDineinOriginRow, source: IMaterializedDineinOriginRow): void;
|
|
36
|
+
/** Merges one payment-type row into another. */
|
|
37
|
+
export declare function mergeMaterializedDineinPaymentRow(target: IMaterializedDineinPaymentRow, source: IMaterializedDineinPaymentRow): void;
|
|
38
|
+
/**
|
|
39
|
+
* Merges `source` into `target`, IN PLACE. Null-safe: a missing sub-map is
|
|
40
|
+
* treated as empty rather than throwing, so one malformed historical document
|
|
41
|
+
* cannot break a whole period fold.
|
|
42
|
+
*/
|
|
43
|
+
export declare function mergeMaterializedDineinCounters(target: IMaterializedDineinCounters, source: IMaterializedDineinCounters): IMaterializedDineinCounters;
|
|
44
|
+
/** Merges one reservation block into another (all counters additive). */
|
|
45
|
+
export declare function mergeMaterializedDineinReservationCounters(target: IMaterializedDineinReservationCounters, source: IMaterializedDineinReservationCounters): IMaterializedDineinReservationCounters;
|
|
46
|
+
/** Applies every document-level bound to one counter map (in place). */
|
|
47
|
+
export declare function pruneDocumentDineinMaps(countersByKey: Record<string, IMaterializedDineinCounters> | Map<string, IMaterializedDineinCounters>, limits?: {
|
|
48
|
+
tables?: number;
|
|
49
|
+
floors?: number;
|
|
50
|
+
courses?: number;
|
|
51
|
+
serviceChargeRates?: number;
|
|
52
|
+
}): void;
|
|
53
|
+
/**
|
|
54
|
+
* Merges the UPCOMING RESERVATION snapshots of several day documents.
|
|
55
|
+
*
|
|
56
|
+
* Dedupe by `reservation_id` (the same booking can be re-closed), then keep the
|
|
57
|
+
* SOONEST `limit` rows. Ordering is `reservation_time ASC, reservation_id ASC`
|
|
58
|
+
* so two folds of the same days produce the same array.
|
|
59
|
+
*/
|
|
60
|
+
export declare function mergeMaterializedDineinUpcomingReservations(lists: readonly (readonly IMaterializedDineinUpcomingReservation[] | null | undefined)[], limit?: number): IMaterializedDineinUpcomingReservation[];
|
|
61
|
+
/**
|
|
62
|
+
* Merges the MOST-EDITED-CHECK snapshots of several day documents.
|
|
63
|
+
*
|
|
64
|
+
* Dedupe by `order_id`, rank `edits DESC, item_additions DESC, order_id ASC`
|
|
65
|
+
* and keep `limit` rows. Deterministic, so a period re-fold is stable.
|
|
66
|
+
*/
|
|
67
|
+
export declare function mergeMaterializedDineinTopEditedChecks(lists: readonly (readonly IMaterializedDineinTopEditedCheck[] | null | undefined)[], limit?: number): IMaterializedDineinTopEditedCheck[];
|