@managesome/eposmatic-toolkit 0.4.55 → 0.4.56

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 (70) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +91 -0
  2. package/esm/helpers/materialized-reports/index.js +7 -0
  3. package/esm/helpers/materialized-reports/materialized-dialer-accumulator-helpers.js +100 -0
  4. package/esm/helpers/materialized-reports/materialized-dialer-close-day-helpers.js +328 -0
  5. package/esm/helpers/materialized-reports/materialized-dialer-compile-helpers.js +180 -0
  6. package/esm/helpers/materialized-reports/materialized-dialer-entry-pages.js +222 -0
  7. package/esm/helpers/materialized-reports/materialized-dialer-key-helpers.js +82 -0
  8. package/esm/helpers/materialized-reports/materialized-dialer-masking.js +54 -0
  9. package/esm/helpers/materialized-reports/materialized-index-bootstrap.js +4 -0
  10. package/esm/helpers/materialized-reports/materialized-report-drilldown-rows.js +13 -1
  11. package/esm/helpers/materialized-reports/report-platform/definition.js +85 -1
  12. package/esm/helpers/materialized-reports/tenant-dialer-formatter.js +95 -0
  13. package/esm/helpers/reporting-contract/report-contract.js +3 -0
  14. package/esm/schemas/models/index.js +2 -0
  15. package/esm/schemas/models/materialized_report_drilldown_rows.js +1 -0
  16. package/esm/schemas/models/materialized_tenant_dialer_entries.js +65 -0
  17. package/esm/schemas/models/materialized_tenant_dialer_reports.js +66 -0
  18. package/esm/schemas/types/index.js +2 -0
  19. package/esm/schemas/types/materialized_report_drilldown_rows.js +1 -0
  20. package/esm/schemas/types/materialized_tenant_dialer_entries.js +1 -0
  21. package/esm/schemas/types/materialized_tenant_dialer_reports.js +7 -0
  22. package/lib/constants/MATERIALIZED_REPORTS.d.ts +72 -2
  23. package/lib/constants/MATERIALIZED_REPORTS.js +93 -1
  24. package/lib/helpers/materialized-reports/index.d.ts +7 -0
  25. package/lib/helpers/materialized-reports/index.js +7 -0
  26. package/lib/helpers/materialized-reports/materialized-dialer-accumulator-helpers.d.ts +39 -0
  27. package/lib/helpers/materialized-reports/materialized-dialer-accumulator-helpers.js +110 -0
  28. package/lib/helpers/materialized-reports/materialized-dialer-close-day-helpers.d.ts +90 -0
  29. package/lib/helpers/materialized-reports/materialized-dialer-close-day-helpers.js +340 -0
  30. package/lib/helpers/materialized-reports/materialized-dialer-compile-helpers.d.ts +67 -0
  31. package/lib/helpers/materialized-reports/materialized-dialer-compile-helpers.js +183 -0
  32. package/lib/helpers/materialized-reports/materialized-dialer-entry-pages.d.ts +97 -0
  33. package/lib/helpers/materialized-reports/materialized-dialer-entry-pages.js +235 -0
  34. package/lib/helpers/materialized-reports/materialized-dialer-key-helpers.d.ts +51 -0
  35. package/lib/helpers/materialized-reports/materialized-dialer-key-helpers.js +90 -0
  36. package/lib/helpers/materialized-reports/materialized-dialer-masking.d.ts +35 -0
  37. package/lib/helpers/materialized-reports/materialized-dialer-masking.js +57 -0
  38. package/lib/helpers/materialized-reports/materialized-index-bootstrap.js +4 -0
  39. package/lib/helpers/materialized-reports/materialized-report-drilldown-rows.js +13 -1
  40. package/lib/helpers/materialized-reports/report-platform/definition.js +84 -0
  41. package/lib/helpers/materialized-reports/tenant-dialer-formatter.d.ts +91 -0
  42. package/lib/helpers/materialized-reports/tenant-dialer-formatter.js +98 -0
  43. package/lib/helpers/reporting-contract/report-contract.d.ts +1 -0
  44. package/lib/helpers/reporting-contract/report-contract.js +3 -0
  45. package/lib/schemas/models/index.d.ts +2 -0
  46. package/lib/schemas/models/index.js +2 -0
  47. package/lib/schemas/models/materialized_report_drilldown_rows.js +1 -0
  48. package/lib/schemas/models/materialized_tenant_dialer_entries.d.ts +107 -0
  49. package/lib/schemas/models/materialized_tenant_dialer_entries.js +68 -0
  50. package/lib/schemas/models/materialized_tenant_dialer_reports.d.ts +100 -0
  51. package/lib/schemas/models/materialized_tenant_dialer_reports.js +69 -0
  52. package/lib/schemas/models/tenant_dialer_events.d.ts +3 -3
  53. package/lib/schemas/types/index.d.ts +2 -0
  54. package/lib/schemas/types/index.js +2 -0
  55. package/lib/schemas/types/materialized_report_drilldown_rows.d.ts +1 -1
  56. package/lib/schemas/types/materialized_report_drilldown_rows.js +1 -0
  57. package/lib/schemas/types/materialized_tenant_dialer_entries.d.ts +83 -0
  58. package/lib/schemas/types/materialized_tenant_dialer_entries.js +2 -0
  59. package/lib/schemas/types/materialized_tenant_dialer_reports.d.ts +77 -0
  60. package/lib/schemas/types/materialized_tenant_dialer_reports.js +10 -0
  61. package/lib/tests/materialized-reports/materialized-dialer-compile.test.d.ts +1 -0
  62. package/lib/tests/materialized-reports/materialized-dialer-compile.test.js +213 -0
  63. package/lib/tests/materialized-reports/materialized-dialer-formatter.test.d.ts +1 -0
  64. package/lib/tests/materialized-reports/materialized-dialer-formatter.test.js +159 -0
  65. package/lib/tests/materialized-reports/materialized-dialer-plan.test.d.ts +1 -0
  66. package/lib/tests/materialized-reports/materialized-dialer-plan.test.js +223 -0
  67. package/lib/tests/materialized-reports/materialized-tenant-dialer-schema.test.d.ts +1 -0
  68. package/lib/tests/materialized-reports/materialized-tenant-dialer-schema.test.js +183 -0
  69. package/lib/tests/materialized-reports/report-platform/registry-conformance.test.js +16 -3
  70. package/package.json +1 -1
@@ -0,0 +1,183 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
4
+ const materialized_tenant_dialer_entries_1 = require("../../schemas/models/materialized_tenant_dialer_entries");
5
+ const materialized_tenant_dialer_reports_1 = require("../../schemas/models/materialized_tenant_dialer_reports");
6
+ const definition_1 = require("../../helpers/materialized-reports/report-platform/definition");
7
+ const validate_report_registry_1 = require("../../helpers/materialized-reports/report-platform/validate-report-registry");
8
+ const report_contract_1 = require("../../helpers/reporting-contract/report-contract");
9
+ /**
10
+ * Dialer schema + registry contract.
11
+ *
12
+ * Indexes are DECLARED here, never created: the model must not call `.index()`
13
+ * and no service runs `ensureIndexes`. Applying them is an owner deploy step.
14
+ */
15
+ describe('dialer schema contract', () => {
16
+ it('declares the two primary collections and their unique identities', () => {
17
+ expect(materialized_tenant_dialer_reports_1.MATERIALIZED_TENANT_DIALER_REPORTS_COLLECTION_NAME).toBe('materialized_tenant_dialer_reports');
18
+ expect(materialized_tenant_dialer_entries_1.MATERIALIZED_TENANT_DIALER_ENTRIES_COLLECTION_NAME).toBe('materialized_tenant_dialer_entries');
19
+ expect(materialized_tenant_dialer_reports_1.MATERIALIZED_TENANT_DIALER_REPORTS_SCHEMA_VERSION).toBe(1);
20
+ expect(materialized_tenant_dialer_entries_1.MATERIALIZED_TENANT_DIALER_ENTRIES_SCHEMA_VERSION).toBe(1);
21
+ expect(materialized_tenant_dialer_reports_1.MATERIALIZED_TENANT_DIALER_REPORTS_COLLECTION_INDEXES.tenant_id__scope_context__scope_field__day_index).toEqual({
22
+ tenant_id: 1,
23
+ scope_context: 1,
24
+ scope_field: 1,
25
+ day_index: 1,
26
+ });
27
+ expect(materialized_tenant_dialer_reports_1.MATERIALIZED_TENANT_DIALER_REPORTS_INDEX_OPTIONS).toEqual([
28
+ {
29
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, day_index: 1 },
30
+ name: 'tenant_id__scope_context__scope_field__day_index',
31
+ unique: true,
32
+ },
33
+ ]);
34
+ expect(materialized_tenant_dialer_entries_1.MATERIALIZED_TENANT_DIALER_ENTRIES_COLLECTION_INDEXES.tenant_id__scope_context__scope_field__page).toEqual({
35
+ tenant_id: 1,
36
+ scope_context: 1,
37
+ scope_field: 1,
38
+ page: 1,
39
+ });
40
+ expect(materialized_tenant_dialer_entries_1.MATERIALIZED_TENANT_DIALER_ENTRIES_INDEX_OPTIONS).toEqual([
41
+ {
42
+ key: { tenant_id: 1, scope_context: 1, scope_field: 1, page: 1 },
43
+ name: 'tenant_id__scope_context__scope_field__page',
44
+ unique: true,
45
+ },
46
+ ]);
47
+ });
48
+ it('declares its scopes, key filters and report types', () => {
49
+ expect(MATERIALIZED_REPORTS_1.MATERIALIZED_DIALER_REPORT_SCOPES).toEqual([
50
+ 'localDate',
51
+ 'localWeek',
52
+ 'localWeekOfYear',
53
+ 'localMonth',
54
+ 'localQuarter',
55
+ 'localSemester',
56
+ 'localYear',
57
+ ]);
58
+ expect(MATERIALIZED_REPORTS_1.MATERIALIZED_DIALER_ENTRY_SCOPES).toEqual(['localDate', 'localWeek', 'localWeekOfYear', 'localMonth']);
59
+ expect(MATERIALIZED_REPORTS_1.DIALER_KEY_FILTERS).toEqual(['ACTION', 'POS_ID', 'STAFF_ID']);
60
+ expect(MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_TYPE_ENUM.TENANT_DIALER_REPORTS).toBe('TENANT_DIALER_REPORTS');
61
+ expect(MATERIALIZED_REPORTS_1.MATERIALIZED_REPORT_TYPE_ENUM.TENANT_DIALER_ENTRIES).toBe('TENANT_DIALER_ENTRIES');
62
+ });
63
+ it('declares the identity fields and defaults on the models', () => {
64
+ const reportPaths = Object.keys(materialized_tenant_dialer_reports_1.MaterializedTenantDialerReportSchema.paths);
65
+ expect(reportPaths).toEqual(expect.arrayContaining([
66
+ 'tenant_id',
67
+ 'brand_id',
68
+ 'scope_context',
69
+ 'scope_field',
70
+ 'day_index',
71
+ 'sale_type_key_filters',
72
+ 'dialer_counters',
73
+ 'schema_version',
74
+ 'source_watermark',
75
+ 'computed_at',
76
+ ]));
77
+ expect(materialized_tenant_dialer_reports_1.MaterializedTenantDialerReportSchema.path('sale_type_key_filters').defaultValue()).toEqual(MATERIALIZED_REPORTS_1.DIALER_KEY_FILTERS);
78
+ const entryPaths = Object.keys(materialized_tenant_dialer_entries_1.MaterializedTenantDialerEntriesSchema.paths);
79
+ expect(entryPaths).toEqual(expect.arrayContaining(['page', 'dialer_entries', 'schema_version', 'source_watermark', 'computed_at']));
80
+ expect(entryPaths).not.toContain('sale_type_key_filters');
81
+ });
82
+ it('keeps the approved raw contract: no duration, order attribution, geo or raw phone', () => {
83
+ const reportPaths = Object.keys(materialized_tenant_dialer_reports_1.MaterializedTenantDialerReportSchema.paths);
84
+ const entryPaths = Object.keys(materialized_tenant_dialer_entries_1.MaterializedTenantDialerEntriesSchema.paths);
85
+ for (const forbidden of [
86
+ 'duration',
87
+ 'duration_seconds',
88
+ 'call_duration',
89
+ 'answer_rate',
90
+ 'missed_rate',
91
+ 'order_id',
92
+ 'phone_number',
93
+ 'staff_phone',
94
+ 'location',
95
+ 'h3_cell',
96
+ ]) {
97
+ expect(reportPaths).not.toContain(forbidden);
98
+ expect(entryPaths).not.toContain(forbidden);
99
+ }
100
+ // The entry row carries MASKED phones only.
101
+ const rowShape = {
102
+ event_id: 'e',
103
+ request_id: 'r',
104
+ action: 'INCOMING_CALL',
105
+ phone_number_masked: '+********4567',
106
+ staff_id: null,
107
+ staff_phone_masked: null,
108
+ pos_id: 'POS-01',
109
+ created_at: '2026-09-14T05:00:00.000Z',
110
+ local_date: '2026-09-14',
111
+ local_hour: 10,
112
+ };
113
+ expect(Object.keys(rowShape).sort()).toEqual([
114
+ 'action',
115
+ 'created_at',
116
+ 'event_id',
117
+ 'local_date',
118
+ 'local_hour',
119
+ 'phone_number_masked',
120
+ 'pos_id',
121
+ 'request_id',
122
+ 'staff_id',
123
+ 'staff_phone_masked',
124
+ ]);
125
+ // No geo projection is registered for this report.
126
+ expect(definition_1.REPORT_DEFINITIONS[report_contract_1.REPORT_KEY_ENUM.DIALER].projections).toEqual([definition_1.REPORT_PROJECTION.FLAT_DRILLDOWN]);
127
+ expect(definition_1.REPORT_DEFINITIONS[report_contract_1.REPORT_KEY_ENUM.DIALER].sideCollections.map((collection) => collection.name)).toEqual([
128
+ 'materialized_report_drilldown_rows',
129
+ 'materialized_report_drilldown_scopes',
130
+ ]);
131
+ });
132
+ });
133
+ describe('dialer report definition', () => {
134
+ const definition = definition_1.REPORT_DEFINITIONS[report_contract_1.REPORT_KEY_ENUM.DIALER];
135
+ it('is a registered production report with the shared contract', () => {
136
+ expect(definition).toBeDefined();
137
+ expect(definition.status).toBe(definition_1.REPORT_DEFINITION_STATUS.PRODUCTION);
138
+ expect(definition.segment).toBe('dialer');
139
+ expect(report_contract_1.REPORT_ROUTE_SEGMENTS[report_contract_1.REPORT_KEY_ENUM.DIALER]).toBe('dialer');
140
+ expect(report_contract_1.REPORT_CAPABILITIES[report_contract_1.REPORT_KEY_ENUM.DIALER]).toEqual({
141
+ live: true,
142
+ historical: true,
143
+ details: true,
144
+ });
145
+ expect(definition.capabilities).toEqual(report_contract_1.REPORT_CAPABILITIES[report_contract_1.REPORT_KEY_ENUM.DIALER]);
146
+ });
147
+ it('declares page-per-source-day entries with deterministic sub-pages and a flat projection', () => {
148
+ expect(definition.entryStorage).toBe(definition_1.REPORT_ENTRY_STORAGE.PAGE_PER_SOURCE_DAY);
149
+ expect(definition.entrySplit).toBe(definition_1.REPORT_ENTRY_SPLIT.DETERMINISTIC_SUBPAGES);
150
+ expect(definition.maxReportScope).toBe('localYear');
151
+ expect(definition.maxEntryScope).toBe('localMonth');
152
+ expect(definition.projections).toEqual([definition_1.REPORT_PROJECTION.FLAT_DRILLDOWN]);
153
+ expect(definition.entryScopes).toEqual(MATERIALIZED_REPORTS_1.MATERIALIZED_DIALER_ENTRY_SCOPES);
154
+ expect(definition.reportScopes).toEqual(MATERIALIZED_REPORTS_1.MATERIALIZED_DIALER_REPORT_SCOPES);
155
+ });
156
+ it('declares server-side key filter dimensions and the report adapter ids', () => {
157
+ expect(definition.filters.map((filter) => filter.id)).toEqual(expect.arrayContaining(['ACTION', 'POS_ID', 'STAFF_ID', 'DETAILS_VIEW']));
158
+ for (const id of ['ACTION', 'POS_ID', 'STAFF_ID']) {
159
+ const filter = definition.filters.find((entry) => entry.id === id);
160
+ expect(filter.mode).toBe('SERVER');
161
+ expect(filter.kind).toBe('KEY_COMPONENT');
162
+ expect(filter.appliesTo).toBe('BOTH');
163
+ }
164
+ expect(definition.adapters).toEqual({
165
+ writer: 'materializeDialerReport',
166
+ live: 'getLiveTenantDialerReports',
167
+ historical: 'getMaterializedTenantDialerReports',
168
+ details: 'getMaterializedDialerDetailsPage',
169
+ });
170
+ expect(definition.cursor).toBe('KEYSET_STRUCTURED');
171
+ });
172
+ it('keeps the declarative registry valid', () => {
173
+ const validation = (0, validate_report_registry_1.validateReportRegistry)();
174
+ expect(validation.errors).toEqual([]);
175
+ expect(validate_report_registry_1.REPORT_REGISTRY_VALIDATION.ok).toBe(true);
176
+ // Validator debt is declared explicitly (no new schema validator was written):
177
+ // the report, the entries, and the two shared flat side collections.
178
+ const dialerWarnings = validation.warnings.filter((warning) => warning.startsWith('DIALER:'));
179
+ expect(dialerWarnings).toHaveLength(4);
180
+ expect(dialerWarnings[0]).toContain('report validator debt');
181
+ expect(dialerWarnings[1]).toContain('entries validator debt');
182
+ });
183
+ });
@@ -49,6 +49,8 @@ const prepEntryModel = __importStar(require("../../../schemas/models/materialize
49
49
  const deliveryReportModel = __importStar(require("../../../schemas/models/materialized_tenant_delivery_reports"));
50
50
  const deliveryEntryModel = __importStar(require("../../../schemas/models/materialized_tenant_delivery_entries"));
51
51
  const deliveryGeoModel = __importStar(require("../../../schemas/models/materialized_tenant_delivery_geo_cells"));
52
+ const dialerReportModel = __importStar(require("../../../schemas/models/materialized_tenant_dialer_reports"));
53
+ const dialerEntryModel = __importStar(require("../../../schemas/models/materialized_tenant_dialer_entries"));
52
54
  const flatModel = __importStar(require("../../../schemas/models/materialized_report_drilldown_rows"));
53
55
  const definition_1 = require("../../../helpers/materialized-reports/report-platform/definition");
54
56
  const registry_1 = require("../../../helpers/materialized-reports/report-platform/registry");
@@ -110,6 +112,16 @@ const MODEL_BY_COLLECTION = {
110
112
  schemaVersion: MATERIALIZED_REPORTS_1.MATERIALIZED_TENANT_DELIVERY_GEO_SCOPES_SCHEMA_VERSION,
111
113
  indexOptions: [],
112
114
  },
115
+ materialized_tenant_dialer_reports: {
116
+ collectionName: dialerReportModel.MATERIALIZED_TENANT_DIALER_REPORTS_COLLECTION_NAME,
117
+ schemaVersion: dialerReportModel.MATERIALIZED_TENANT_DIALER_REPORTS_SCHEMA_VERSION,
118
+ indexOptions: dialerReportModel.MATERIALIZED_TENANT_DIALER_REPORTS_INDEX_OPTIONS,
119
+ },
120
+ materialized_tenant_dialer_entries: {
121
+ collectionName: dialerEntryModel.MATERIALIZED_TENANT_DIALER_ENTRIES_COLLECTION_NAME,
122
+ schemaVersion: dialerEntryModel.MATERIALIZED_TENANT_DIALER_ENTRIES_SCHEMA_VERSION,
123
+ indexOptions: dialerEntryModel.MATERIALIZED_TENANT_DIALER_ENTRIES_INDEX_OPTIONS,
124
+ },
113
125
  materialized_report_drilldown_rows: {
114
126
  collectionName: flatModel.MATERIALIZED_REPORT_DRILLDOWN_ROWS_COLLECTION_NAME,
115
127
  schemaVersion: flatModel.MATERIALIZED_REPORT_DRILLDOWN_ROWS_SCHEMA_VERSION,
@@ -127,15 +139,16 @@ const definitionCollections = () => definition_1.PRODUCTION_REPORT_DEFINITIONS.f
127
139
  ...definition.sideCollections,
128
140
  ]);
129
141
  describe('report registry conformance', () => {
130
- it('defines exactly the four production reports', () => {
142
+ it('defines exactly the production reports', () => {
131
143
  expect(definition_1.PRODUCTION_REPORT_DEFINITIONS.map((definition) => definition.key)).toEqual([
132
144
  report_contract_1.REPORT_KEY_ENUM.OVERVIEW,
133
145
  report_contract_1.REPORT_KEY_ENUM.DISCOUNTS,
134
146
  report_contract_1.REPORT_KEY_ENUM.PREP_TIME,
135
147
  report_contract_1.REPORT_KEY_ENUM.DELIVERY,
148
+ report_contract_1.REPORT_KEY_ENUM.DIALER,
136
149
  ]);
137
- expect((0, registry_1.getProductionReportDefinitions)()).toHaveLength(4);
138
- expect(new Set(definition_1.PRODUCTION_REPORT_DEFINITIONS.map((definition) => definition.key)).size).toBe(4);
150
+ expect((0, registry_1.getProductionReportDefinitions)()).toHaveLength(5);
151
+ expect(new Set(definition_1.PRODUCTION_REPORT_DEFINITIONS.map((definition) => definition.key)).size).toBe(5);
139
152
  expect(definition_1.PRODUCTION_REPORT_DEFINITIONS.every((definition) => definition.status === 'PRODUCTION')).toBe(true);
140
153
  });
141
154
  it('covers every REPORT_KEY with a definition or an explicit exemption', () => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@managesome/eposmatic-toolkit",
3
- "version": "0.4.55",
3
+ "version": "0.4.56",
4
4
  "description": "A Toolkit Library for Eposmatic",
5
5
  "main": "lib/index.js",
6
6
  "module": "esm/index.js",