@managesome/eposmatic-toolkit 0.3.11 → 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 (52) hide show
  1. package/esm/constants/MATERIALIZED_REPORTS.js +105 -0
  2. package/esm/helpers/materialized-reports/index.js +5 -0
  3. package/esm/helpers/materialized-reports/key-helpers.js +59 -0
  4. package/esm/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.js +60 -0
  5. package/esm/helpers/materialized-reports/scope-helpers.js +107 -0
  6. package/esm/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +251 -0
  7. package/esm/helpers/materialized-reports/tenant-sales-overview-helpers.js +860 -0
  8. package/esm/schemas/models/materialized_tenant_reports_iterations.js +82 -0
  9. package/esm/schemas/models/materialized_tenant_sales_overview_reports.js +399 -0
  10. package/esm/schemas/types/materialized_tenant_reports_iterations.js +1 -0
  11. package/esm/schemas/types/materialized_tenant_sales_overview_reports.js +1 -0
  12. package/lib/constants/MATERIALIZED_REPORTS.d.ts +96 -0
  13. package/lib/constants/MATERIALIZED_REPORTS.js +108 -0
  14. package/lib/helpers/materialized-reports/index.d.ts +5 -0
  15. package/lib/helpers/materialized-reports/index.js +21 -0
  16. package/lib/helpers/materialized-reports/key-helpers.d.ts +35 -0
  17. package/lib/helpers/materialized-reports/key-helpers.js +64 -0
  18. package/lib/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.d.ts +66 -0
  19. package/lib/helpers/materialized-reports/materialized-tenant-reports-iterations-helpers.js +63 -0
  20. package/lib/helpers/materialized-reports/scope-helpers.d.ts +57 -0
  21. package/lib/helpers/materialized-reports/scope-helpers.js +114 -0
  22. package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.d.ts +125 -0
  23. package/lib/helpers/materialized-reports/tenant-sales-overview-close-day-helpers.js +256 -0
  24. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.d.ts +223 -0
  25. package/lib/helpers/materialized-reports/tenant-sales-overview-helpers.js +875 -0
  26. package/lib/schemas/models/materialized_tenant_reports_iterations.d.ts +80 -0
  27. package/lib/schemas/models/materialized_tenant_reports_iterations.js +85 -0
  28. package/lib/schemas/models/materialized_tenant_sales_overview_reports.d.ts +569 -0
  29. package/lib/schemas/models/materialized_tenant_sales_overview_reports.js +402 -0
  30. package/lib/schemas/types/materialized_tenant_reports_iterations.d.ts +62 -0
  31. package/lib/schemas/types/materialized_tenant_reports_iterations.js +2 -0
  32. package/lib/schemas/types/materialized_tenant_sales_overview_reports.d.ts +242 -0
  33. package/lib/schemas/types/materialized_tenant_sales_overview_reports.js +3 -0
  34. package/lib/tests/materialized-reports/fixtures.d.ts +81 -0
  35. package/lib/tests/materialized-reports/fixtures.js +87 -0
  36. package/lib/tests/materialized-reports/fixtures.test.d.ts +1 -0
  37. package/lib/tests/materialized-reports/fixtures.test.js +123 -0
  38. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-helpers.test.d.ts +1 -0
  39. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-helpers.test.js +75 -0
  40. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-schema.test.d.ts +1 -0
  41. package/lib/tests/materialized-reports/materialized-tenant-reports-iterations-schema.test.js +73 -0
  42. package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.d.ts +1 -0
  43. package/lib/tests/materialized-reports/materialized-tenant-sales-overview-reports-schema.test.js +207 -0
  44. package/lib/tests/materialized-reports/sales-overview-baseline.test.d.ts +1 -0
  45. package/lib/tests/materialized-reports/sales-overview-baseline.test.js +326 -0
  46. package/lib/tests/materialized-reports/sales-overview-reference.d.ts +63 -0
  47. package/lib/tests/materialized-reports/sales-overview-reference.js +131 -0
  48. package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.d.ts +1 -0
  49. package/lib/tests/materialized-reports/tenant-sales-overview-close-day-helpers.test.js +335 -0
  50. package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.d.ts +1 -0
  51. package/lib/tests/materialized-reports/tenant-sales-overview-helpers.test.js +885 -0
  52. package/package.json +5 -2
@@ -0,0 +1,80 @@
1
+ import { Schema } from 'mongoose';
2
+ /**
3
+ * Mongoose schema for `materialized_tenant_reports_iterations` — the shared iteration
4
+ * history of every materialized report collection (see
5
+ * `MATERIALIZED_REPORTS.md`, "Iteration history").
6
+ *
7
+ * One append-only row per VERSIONED write of a report document; `snapshot`
8
+ * holds the full report document AFTER the write. `snapshot` is Mixed because
9
+ * the collection serves every report kind (`report_type` discriminates).
10
+ * Received-payment patches that change the ledger are versioned writes too
11
+ * (they bump `iteration` and append rows); no-op patches write nothing.
12
+ * Every row carries the backend-generated `reason` for the audit trail.
13
+ */
14
+ export declare const MaterializedTenantReportIterationSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
15
+ timestamps: true;
16
+ versionKey: false;
17
+ minimize: false;
18
+ }, {
19
+ createdAt: NativeDate;
20
+ updatedAt: NativeDate;
21
+ } & {
22
+ _id: import("mongoose").Types.ObjectId;
23
+ reason: string;
24
+ createdAt: NativeDate;
25
+ updatedAt: NativeDate;
26
+ iteration: number;
27
+ report_type: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_TYPE_ENUM.TENANT_SALES_OVERVIEW;
28
+ report_id: import("mongoose").Types.ObjectId;
29
+ schema_version: number;
30
+ snapshot: any;
31
+ }, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
32
+ createdAt: NativeDate;
33
+ updatedAt: NativeDate;
34
+ } & {
35
+ _id: import("mongoose").Types.ObjectId;
36
+ reason: string;
37
+ createdAt: NativeDate;
38
+ updatedAt: NativeDate;
39
+ iteration: number;
40
+ report_type: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_TYPE_ENUM.TENANT_SALES_OVERVIEW;
41
+ report_id: import("mongoose").Types.ObjectId;
42
+ schema_version: number;
43
+ snapshot: any;
44
+ }>> & import("mongoose").FlatRecord<{
45
+ createdAt: NativeDate;
46
+ updatedAt: NativeDate;
47
+ } & {
48
+ _id: import("mongoose").Types.ObjectId;
49
+ reason: string;
50
+ createdAt: NativeDate;
51
+ updatedAt: NativeDate;
52
+ iteration: number;
53
+ report_type: import("../../constants/MATERIALIZED_REPORTS").MATERIALIZED_REPORT_TYPE_ENUM.TENANT_SALES_OVERVIEW;
54
+ report_id: import("mongoose").Types.ObjectId;
55
+ schema_version: number;
56
+ snapshot: any;
57
+ }> & Required<{
58
+ _id: import("mongoose").Types.ObjectId;
59
+ }> & {
60
+ __v: number;
61
+ }>;
62
+ export declare const MATERIALIZED_TENANT_REPORTS_ITERATIONS_COLLECTION_NAME = "materialized_tenant_reports_iterations";
63
+ /**
64
+ * Indexes for `materialized_tenant_reports_iterations` (values are Mongo key patterns that
65
+ * can be passed straight to `.hint()`):
66
+ * - `_id`: unique primary key.
67
+ * - `report_id__iteration`: UNIQUE — one row per (report, iteration); serves
68
+ * per-report history reads (`{ report_id }` + `.sort({ iteration: -1 })`;
69
+ * the head row mirrors the live document) and doubles as the idempotent
70
+ * upsert key (`replaceOne({ report_id, iteration }, row, { upsert: true })`).
71
+ */
72
+ export declare const MATERIALIZED_TENANT_REPORTS_ITERATIONS_COLLECTION_INDEXES: {
73
+ _id: {
74
+ _id: number;
75
+ };
76
+ report_id__iteration: {
77
+ report_id: number;
78
+ iteration: number;
79
+ };
80
+ };
@@ -0,0 +1,85 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MATERIALIZED_TENANT_REPORTS_ITERATIONS_COLLECTION_INDEXES = exports.MATERIALIZED_TENANT_REPORTS_ITERATIONS_COLLECTION_NAME = exports.MaterializedTenantReportIterationSchema = void 0;
4
+ const mongoose_1 = require("mongoose");
5
+ const MATERIALIZED_REPORTS_1 = require("../../constants/MATERIALIZED_REPORTS");
6
+ /**
7
+ * Mongoose schema for `materialized_tenant_reports_iterations` — the shared iteration
8
+ * history of every materialized report collection (see
9
+ * `MATERIALIZED_REPORTS.md`, "Iteration history").
10
+ *
11
+ * One append-only row per VERSIONED write of a report document; `snapshot`
12
+ * holds the full report document AFTER the write. `snapshot` is Mixed because
13
+ * the collection serves every report kind (`report_type` discriminates).
14
+ * Received-payment patches that change the ledger are versioned writes too
15
+ * (they bump `iteration` and append rows); no-op patches write nothing.
16
+ * Every row carries the backend-generated `reason` for the audit trail.
17
+ */
18
+ exports.MaterializedTenantReportIterationSchema = new mongoose_1.Schema({
19
+ _id: {
20
+ type: mongoose_1.Schema.Types.ObjectId,
21
+ required: true,
22
+ immutable: true,
23
+ },
24
+ report_type: {
25
+ type: String,
26
+ enum: MATERIALIZED_REPORTS_1.ALL_MATERIALIZED_REPORT_TYPES,
27
+ required: true,
28
+ immutable: true,
29
+ },
30
+ report_id: {
31
+ type: mongoose_1.Schema.Types.ObjectId,
32
+ required: true,
33
+ immutable: true,
34
+ },
35
+ iteration: {
36
+ type: Number,
37
+ required: true,
38
+ min: 1,
39
+ },
40
+ schema_version: {
41
+ type: Number,
42
+ required: true,
43
+ },
44
+ // Why the iteration happened — backend-generated free string, e.g.
45
+ // 'NEW_DAY' | 'RECLOSE' | 'RECONCILE' | 'CREDIT_BILL_COLLECTED'.
46
+ reason: {
47
+ type: String,
48
+ required: true,
49
+ },
50
+ // Full report document as written — polymorphic across report kinds, so
51
+ // untyped/Mixed; narrow by `report_type` (see the type file).
52
+ snapshot: {
53
+ type: mongoose_1.Schema.Types.Mixed,
54
+ required: true,
55
+ },
56
+ createdAt: {
57
+ type: mongoose_1.Schema.Types.Date,
58
+ required: true,
59
+ default: () => new Date(),
60
+ immutable: true,
61
+ },
62
+ updatedAt: {
63
+ type: mongoose_1.Schema.Types.Date,
64
+ required: true,
65
+ default: () => new Date(),
66
+ },
67
+ }, {
68
+ timestamps: true,
69
+ versionKey: false,
70
+ minimize: false,
71
+ });
72
+ exports.MATERIALIZED_TENANT_REPORTS_ITERATIONS_COLLECTION_NAME = 'materialized_tenant_reports_iterations';
73
+ /**
74
+ * Indexes for `materialized_tenant_reports_iterations` (values are Mongo key patterns that
75
+ * can be passed straight to `.hint()`):
76
+ * - `_id`: unique primary key.
77
+ * - `report_id__iteration`: UNIQUE — one row per (report, iteration); serves
78
+ * per-report history reads (`{ report_id }` + `.sort({ iteration: -1 })`;
79
+ * the head row mirrors the live document) and doubles as the idempotent
80
+ * upsert key (`replaceOne({ report_id, iteration }, row, { upsert: true })`).
81
+ */
82
+ exports.MATERIALIZED_TENANT_REPORTS_ITERATIONS_COLLECTION_INDEXES = {
83
+ _id: { _id: 1 }, // Unique Index
84
+ report_id__iteration: { report_id: 1, iteration: -1 }, // unique — one row per (report, iteration)
85
+ };