@talkpilot/core-db 1.3.6 → 1.3.7

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 (167) hide show
  1. package/.cursor/rules/development.mdc +65 -65
  2. package/DEVELOPMENT.md +141 -141
  3. package/README.md +190 -190
  4. package/README_OLD.md +160 -160
  5. package/dist/talkpilot/flows/flows.schema.d.ts +3 -0
  6. package/dist/talkpilot/flows/flows.schema.d.ts.map +1 -1
  7. package/dist/talkpilot/flows/flows.schema.js +1 -0
  8. package/dist/talkpilot/flows/flows.schema.js.map +1 -1
  9. package/dist/talkpilot/flows/flows.types.d.ts +1 -0
  10. package/dist/talkpilot/flows/flows.types.d.ts.map +1 -1
  11. package/jest.config.js +20 -20
  12. package/package.json +46 -46
  13. package/src/__tests__/setup.ts +20 -20
  14. package/src/connection.ts +54 -54
  15. package/src/index.ts +26 -26
  16. package/src/municipal/__tests__/validation.spec.ts +62 -62
  17. package/src/municipal/cities/cities.getters.ts +50 -50
  18. package/src/municipal/cities/cities.types.ts +11 -11
  19. package/src/municipal/cities/index.ts +2 -2
  20. package/src/municipal/departmentsSubjects/departmentsSubjects.getters.ts +282 -282
  21. package/src/municipal/departmentsSubjects/departmentsSubjects.types.ts +72 -72
  22. package/src/municipal/departmentsSubjects/index.ts +9 -9
  23. package/src/municipal/index.ts +22 -22
  24. package/src/municipal/mongodb-client.ts +61 -61
  25. package/src/municipal/muniIssues/__tests__/muniIssues.setters.spec.ts +92 -92
  26. package/src/municipal/muniIssues/__tests__/muniIssues.setup.spec.ts +92 -92
  27. package/src/municipal/muniIssues/index.ts +17 -17
  28. package/src/municipal/muniIssues/muniIssues.constants.ts +18 -18
  29. package/src/municipal/muniIssues/muniIssues.getters.ts +24 -24
  30. package/src/municipal/muniIssues/muniIssues.schema.ts +66 -66
  31. package/src/municipal/muniIssues/muniIssues.setters.ts +24 -24
  32. package/src/municipal/muniIssues/muniIssues.setup.ts +65 -65
  33. package/src/municipal/muniIssues/muniIssues.types.ts +37 -37
  34. package/src/municipal/streets/index.ts +2 -2
  35. package/src/municipal/streets/streets.getters.ts +125 -125
  36. package/src/municipal/streets/streets.types.ts +18 -18
  37. package/src/municipal/systemInstructions/__tests__/getters.spec.ts +113 -113
  38. package/src/municipal/systemInstructions/__tests__/setters.spec.ts +274 -274
  39. package/src/municipal/systemInstructions/index.ts +7 -7
  40. package/src/municipal/systemInstructions/instructions.getters.ts +57 -57
  41. package/src/municipal/systemInstructions/instructions.setters.ts +119 -119
  42. package/src/municipal/systemInstructions/instructions.types.ts +30 -30
  43. package/src/municipal/tickets/__tests__/tickets.getters.spec.ts +30 -30
  44. package/src/municipal/tickets/__tests__/tickets.statistics.spec.ts +51 -51
  45. package/src/municipal/tickets/index.ts +3 -3
  46. package/src/municipal/tickets/tickets.constants.ts +8 -8
  47. package/src/municipal/tickets/tickets.getters.ts +121 -121
  48. package/src/municipal/tickets/tickets.statistics.aggregation.ts +96 -96
  49. package/src/municipal/tickets/tickets.statistics.getters.ts +71 -71
  50. package/src/municipal/tickets/tickets.types.ts +53 -53
  51. package/src/municipal/utils/types.ts +11 -11
  52. package/src/talkpilot/__tests__/db.spec.ts +38 -38
  53. package/src/talkpilot/__tests__/mongodb-client.spec.ts +18 -18
  54. package/src/talkpilot/__tests__/validation.spec.ts +68 -68
  55. package/src/talkpilot/agents/__tests__/agents.getters.spec.ts +29 -29
  56. package/src/talkpilot/agents/agents.getters.ts +34 -34
  57. package/src/talkpilot/agents/agents.types.ts +14 -14
  58. package/src/talkpilot/agents/index.ts +2 -2
  59. package/src/talkpilot/backgroundToolResults/__tests__/backgroundToolResults.getters.spec.ts +147 -147
  60. package/src/talkpilot/backgroundToolResults/backgroundToolResults.getters.ts +65 -65
  61. package/src/talkpilot/backgroundToolResults/backgroundToolResults.types.ts +23 -23
  62. package/src/talkpilot/backgroundToolResults/index.ts +2 -2
  63. package/src/talkpilot/calls/__tests__/callStats.utils.spec.ts +128 -128
  64. package/src/talkpilot/calls/__tests__/calls.dashboard.spec.ts +149 -149
  65. package/src/talkpilot/calls/__tests__/calls.spec.ts +270 -270
  66. package/src/talkpilot/calls/__tests__/calls.statistics.spec.ts +344 -344
  67. package/src/talkpilot/calls/calls.constants.ts +20 -20
  68. package/src/talkpilot/calls/calls.getters.ts +248 -248
  69. package/src/talkpilot/calls/calls.statistics.getters.ts +587 -587
  70. package/src/talkpilot/calls/calls.statistics.types.ts +44 -44
  71. package/src/talkpilot/calls/calls.types.ts +119 -119
  72. package/src/talkpilot/calls/dashboard/calls.dashboard.ts +292 -292
  73. package/src/talkpilot/calls/dashboard/calls.dashboard.types.ts +57 -57
  74. package/src/talkpilot/calls/index.ts +6 -6
  75. package/src/talkpilot/clientAudioBuffers/__tests__/clientAudioBuffer.getters.spec.ts +160 -160
  76. package/src/talkpilot/clientAudioBuffers/clientAudioBuffer.getters.ts +117 -117
  77. package/src/talkpilot/clientAudioBuffers/clientsAudioBuffers.types.ts +25 -25
  78. package/src/talkpilot/clientAudioBuffers/index.ts +2 -2
  79. package/src/talkpilot/clients/clients.getters.ts +16 -16
  80. package/src/talkpilot/clients/clients.types.ts +14 -14
  81. package/src/talkpilot/clients/index.ts +2 -2
  82. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.getters.spec.ts +53 -53
  83. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.spec.ts +190 -190
  84. package/src/talkpilot/clientsConfig/clientsConfig.getters.ts +55 -55
  85. package/src/talkpilot/clientsConfig/clientsConfig.types.ts +127 -127
  86. package/src/talkpilot/clientsConfig/index.ts +2 -2
  87. package/src/talkpilot/contextNotes/__tests__/contextNotes.getters.spec.ts +176 -176
  88. package/src/talkpilot/contextNotes/contextNotes.getters.ts +86 -86
  89. package/src/talkpilot/contextNotes/contextNotes.types.ts +20 -20
  90. package/src/talkpilot/contextNotes/index.ts +2 -2
  91. package/src/talkpilot/flows/__tests__/flows.schema.spec.ts +96 -71
  92. package/src/talkpilot/flows/flows.getter.ts +14 -14
  93. package/src/talkpilot/flows/flows.schema.ts +154 -153
  94. package/src/talkpilot/flows/flows.types.ts +187 -186
  95. package/src/talkpilot/flows/index.ts +2 -2
  96. package/src/talkpilot/groups/__tests__/groups.spec.ts +90 -90
  97. package/src/talkpilot/groups/__tests__/phone.utils.spec.ts +32 -32
  98. package/src/talkpilot/groups/groups.getters.ts +30 -30
  99. package/src/talkpilot/groups/groups.types.ts +29 -29
  100. package/src/talkpilot/groups/index.ts +3 -3
  101. package/src/talkpilot/groups/phone.utils.ts +46 -46
  102. package/src/talkpilot/index.ts +31 -31
  103. package/src/talkpilot/leads/index.ts +2 -2
  104. package/src/talkpilot/leads/leads.getter.ts +6 -6
  105. package/src/talkpilot/leads/leads.schema.ts +33 -33
  106. package/src/talkpilot/leads/leads.types.ts +20 -20
  107. package/src/talkpilot/mongodb-client.ts +78 -78
  108. package/src/talkpilot/phone_numbers/__tests__/phone_numbers.spec.ts +252 -252
  109. package/src/talkpilot/phone_numbers/index.ts +2 -2
  110. package/src/talkpilot/phone_numbers/phone_numbers.getter.ts +158 -158
  111. package/src/talkpilot/phone_numbers/phone_numbers.schema.ts +17 -17
  112. package/src/talkpilot/phone_numbers/phone_numbers.types.ts +30 -30
  113. package/src/talkpilot/plans/__tests__/plans.spec.ts +70 -70
  114. package/src/talkpilot/plans/index.ts +2 -2
  115. package/src/talkpilot/plans/plans.getters.ts +132 -132
  116. package/src/talkpilot/plans/plans.types.ts +89 -89
  117. package/src/talkpilot/products/__tests__/products.getters.spec.ts +45 -45
  118. package/src/talkpilot/products/index.ts +2 -2
  119. package/src/talkpilot/products/products.getters.ts +12 -12
  120. package/src/talkpilot/products/products.types.ts +9 -9
  121. package/src/talkpilot/results/index.ts +7 -7
  122. package/src/talkpilot/results/results.getter.ts +39 -39
  123. package/src/talkpilot/results/results.schema.ts +25 -25
  124. package/src/talkpilot/results/results.types.ts +34 -34
  125. package/src/talkpilot/retry_analyze/__tests__/retryAnalyze.getters.spec.ts +156 -156
  126. package/src/talkpilot/retry_analyze/index.ts +2 -2
  127. package/src/talkpilot/retry_analyze/retryAnalyze.getters.ts +84 -84
  128. package/src/talkpilot/retry_analyze/retryAnalyze.types.ts +13 -13
  129. package/src/talkpilot/sessions/__tests__/sessions.spec.ts +147 -147
  130. package/src/talkpilot/sessions/index.ts +2 -2
  131. package/src/talkpilot/sessions/sessions.getter.ts +92 -92
  132. package/src/talkpilot/sessions/sessions.schema.ts +34 -34
  133. package/src/talkpilot/sessions/sessions.types.ts +30 -30
  134. package/src/talkpilot/subscriptions/__tests__/subscriptions.getters.utils.spec.ts +45 -45
  135. package/src/talkpilot/subscriptions/index.ts +3 -3
  136. package/src/talkpilot/subscriptions/subscriptions.getters.ts +146 -146
  137. package/src/talkpilot/subscriptions/subscriptions.getters.utils.ts +33 -33
  138. package/src/talkpilot/subscriptions/subscriptions.types.ts +66 -66
  139. package/src/talkpilot/utils/__tests__/query.utils.spec.ts +49 -49
  140. package/src/talkpilot/utils/query.utils.ts +21 -21
  141. package/src/test-utils/db-utils.ts +26 -26
  142. package/src/test-utils/factories/index.ts +15 -15
  143. package/src/test-utils/factories/municipal/cities.ts +16 -16
  144. package/src/test-utils/factories/municipal/departmentsSubjects.ts +37 -37
  145. package/src/test-utils/factories/municipal/muniIssues.ts +32 -32
  146. package/src/test-utils/factories/municipal/streets.ts +22 -22
  147. package/src/test-utils/factories/municipal/tickets.ts +39 -39
  148. package/src/test-utils/factories/talkpilot/agents.ts +19 -19
  149. package/src/test-utils/factories/talkpilot/calls.ts +37 -37
  150. package/src/test-utils/factories/talkpilot/clientAudioBuffers.ts +20 -20
  151. package/src/test-utils/factories/talkpilot/clientsConfig.ts +18 -18
  152. package/src/test-utils/factories/talkpilot/contextNotes.ts +33 -33
  153. package/src/test-utils/factories/talkpilot/flows.ts +33 -33
  154. package/src/test-utils/factories/talkpilot/groups.ts +33 -33
  155. package/src/test-utils/factories/talkpilot/phone_numbers.ts +22 -22
  156. package/src/test-utils/factories/talkpilot/sessions.ts +35 -35
  157. package/src/test-utils/factories/websitalk/scans.ts +23 -23
  158. package/src/utils/date.utils.ts +116 -116
  159. package/src/utils/shared.types.ts +4 -4
  160. package/src/utils/validation.ts +23 -23
  161. package/src/websitalk/index.ts +15 -15
  162. package/src/websitalk/mongodb-client.ts +61 -61
  163. package/src/websitalk/scans/__tests__/scans.spec.ts +218 -218
  164. package/src/websitalk/scans/index.ts +2 -2
  165. package/src/websitalk/scans/scans.getters.ts +113 -113
  166. package/src/websitalk/scans/scans.types.ts +53 -53
  167. package/tsconfig.json +23 -23
@@ -1,132 +1,132 @@
1
- import {
2
- getDb,
3
- Plan,
4
- PlanDoc,
5
- PlanFilter,
6
- PlanQueryOptions,
7
- SimplePlanFilter,
8
- } from "../index";
9
- import { Filter, ObjectId } from "mongodb";
10
- import { applyQueryOptions } from "../utils/query.utils";
11
-
12
- export const getPlansCollection = () => {
13
- return getDb().collection<Plan>("plans");
14
- };
15
-
16
- /**
17
- * Converts a simple filter to MongoDB query format
18
- */
19
- const buildSimpleQuery = (filter: SimplePlanFilter): Filter<Plan> => {
20
- const query: Filter<Plan> = {};
21
-
22
- if (filter._id) {
23
- query._id = new ObjectId(filter._id);
24
- }
25
- if (filter.productKey !== undefined) {
26
- query.productKey = filter.productKey;
27
- }
28
- if (filter.isActive !== undefined) {
29
- query.isActive = filter.isActive;
30
- }
31
- if (filter.currency !== undefined) {
32
- query.currency = filter.currency;
33
- }
34
- if (filter.region !== undefined) {
35
- query.region = filter.region;
36
- }
37
- if (filter.countryCode !== undefined) {
38
- query.countryCode = filter.countryCode;
39
- }
40
- if (filter.originalPlanId !== undefined) {
41
- query.originalPlanId = filter.originalPlanId;
42
- }
43
-
44
- return query;
45
- };
46
-
47
- /**
48
- * Generic function to find plans with flexible filtering
49
- */
50
- export const findPlans = async (
51
- filter?: PlanFilter,
52
- options?: PlanQueryOptions,
53
- ): Promise<PlanDoc[]> => {
54
- let query: Filter<Plan> = {};
55
-
56
- if (filter) {
57
- // Build the base query from simple filter properties
58
- const simpleFilter: SimplePlanFilter = {
59
- _id: filter._id,
60
- productKey: filter.productKey,
61
- isActive: filter.isActive,
62
- currency: filter.currency,
63
- region: filter.region,
64
- countryCode: filter.countryCode,
65
- originalPlanId: filter.originalPlanId,
66
- };
67
-
68
- // Apply simple filters if any are present
69
- const baseQuery = buildSimpleQuery(simpleFilter);
70
- if (Object.keys(baseQuery).length > 0) {
71
- query = baseQuery;
72
- }
73
-
74
- // Add OR conditions if present
75
- if (filter.or && filter.or.length > 0) {
76
- query.$or = filter.or.map(buildSimpleQuery);
77
- }
78
-
79
- // Add AND conditions if present
80
- if (filter.and && filter.and.length > 0) {
81
- query.$and = filter.and.map(buildSimpleQuery);
82
- }
83
- }
84
-
85
- const cursor = getPlansCollection().find(query);
86
- return await applyQueryOptions(cursor, options).toArray();
87
- };
88
-
89
- export const findPlansByQuery = async (
90
- query: Filter<Plan>,
91
- options?: PlanQueryOptions,
92
- ): Promise<PlanDoc[]> => {
93
- const cursor = getPlansCollection().find(query);
94
- return await applyQueryOptions(cursor, options).toArray();
95
- };
96
-
97
- export const countPlans = async (query: Filter<Plan>): Promise<number> => {
98
- return getPlansCollection().countDocuments(query);
99
- };
100
-
101
- export const createPlanDoc = async (
102
- planData: Omit<Plan, "createdAt" | "updatedAt">,
103
- ): Promise<PlanDoc> => {
104
- const now = new Date();
105
- const result = await getPlansCollection().insertOne({
106
- ...planData,
107
- createdAt: now,
108
- updatedAt: now,
109
- });
110
-
111
- const plans = await findPlans({ _id: result.insertedId });
112
- if (!plans[0]) throw new Error("Failed to retrieve created plan");
113
- return plans[0];
114
- };
115
-
116
- export const updatePlanDoc = async (
117
- planId: ObjectId,
118
- updates: Partial<Omit<Plan, "createdAt" | "updatedAt">>,
119
- ): Promise<PlanDoc | null> => {
120
- return await getPlansCollection().findOneAndUpdate(
121
- { _id: planId },
122
- {
123
- $set: {
124
- ...updates,
125
- updatedAt: new Date(),
126
- },
127
- },
128
- {
129
- returnDocument: "after",
130
- },
131
- );
132
- };
1
+ import {
2
+ getDb,
3
+ Plan,
4
+ PlanDoc,
5
+ PlanFilter,
6
+ PlanQueryOptions,
7
+ SimplePlanFilter,
8
+ } from "../index";
9
+ import { Filter, ObjectId } from "mongodb";
10
+ import { applyQueryOptions } from "../utils/query.utils";
11
+
12
+ export const getPlansCollection = () => {
13
+ return getDb().collection<Plan>("plans");
14
+ };
15
+
16
+ /**
17
+ * Converts a simple filter to MongoDB query format
18
+ */
19
+ const buildSimpleQuery = (filter: SimplePlanFilter): Filter<Plan> => {
20
+ const query: Filter<Plan> = {};
21
+
22
+ if (filter._id) {
23
+ query._id = new ObjectId(filter._id);
24
+ }
25
+ if (filter.productKey !== undefined) {
26
+ query.productKey = filter.productKey;
27
+ }
28
+ if (filter.isActive !== undefined) {
29
+ query.isActive = filter.isActive;
30
+ }
31
+ if (filter.currency !== undefined) {
32
+ query.currency = filter.currency;
33
+ }
34
+ if (filter.region !== undefined) {
35
+ query.region = filter.region;
36
+ }
37
+ if (filter.countryCode !== undefined) {
38
+ query.countryCode = filter.countryCode;
39
+ }
40
+ if (filter.originalPlanId !== undefined) {
41
+ query.originalPlanId = filter.originalPlanId;
42
+ }
43
+
44
+ return query;
45
+ };
46
+
47
+ /**
48
+ * Generic function to find plans with flexible filtering
49
+ */
50
+ export const findPlans = async (
51
+ filter?: PlanFilter,
52
+ options?: PlanQueryOptions,
53
+ ): Promise<PlanDoc[]> => {
54
+ let query: Filter<Plan> = {};
55
+
56
+ if (filter) {
57
+ // Build the base query from simple filter properties
58
+ const simpleFilter: SimplePlanFilter = {
59
+ _id: filter._id,
60
+ productKey: filter.productKey,
61
+ isActive: filter.isActive,
62
+ currency: filter.currency,
63
+ region: filter.region,
64
+ countryCode: filter.countryCode,
65
+ originalPlanId: filter.originalPlanId,
66
+ };
67
+
68
+ // Apply simple filters if any are present
69
+ const baseQuery = buildSimpleQuery(simpleFilter);
70
+ if (Object.keys(baseQuery).length > 0) {
71
+ query = baseQuery;
72
+ }
73
+
74
+ // Add OR conditions if present
75
+ if (filter.or && filter.or.length > 0) {
76
+ query.$or = filter.or.map(buildSimpleQuery);
77
+ }
78
+
79
+ // Add AND conditions if present
80
+ if (filter.and && filter.and.length > 0) {
81
+ query.$and = filter.and.map(buildSimpleQuery);
82
+ }
83
+ }
84
+
85
+ const cursor = getPlansCollection().find(query);
86
+ return await applyQueryOptions(cursor, options).toArray();
87
+ };
88
+
89
+ export const findPlansByQuery = async (
90
+ query: Filter<Plan>,
91
+ options?: PlanQueryOptions,
92
+ ): Promise<PlanDoc[]> => {
93
+ const cursor = getPlansCollection().find(query);
94
+ return await applyQueryOptions(cursor, options).toArray();
95
+ };
96
+
97
+ export const countPlans = async (query: Filter<Plan>): Promise<number> => {
98
+ return getPlansCollection().countDocuments(query);
99
+ };
100
+
101
+ export const createPlanDoc = async (
102
+ planData: Omit<Plan, "createdAt" | "updatedAt">,
103
+ ): Promise<PlanDoc> => {
104
+ const now = new Date();
105
+ const result = await getPlansCollection().insertOne({
106
+ ...planData,
107
+ createdAt: now,
108
+ updatedAt: now,
109
+ });
110
+
111
+ const plans = await findPlans({ _id: result.insertedId });
112
+ if (!plans[0]) throw new Error("Failed to retrieve created plan");
113
+ return plans[0];
114
+ };
115
+
116
+ export const updatePlanDoc = async (
117
+ planId: ObjectId,
118
+ updates: Partial<Omit<Plan, "createdAt" | "updatedAt">>,
119
+ ): Promise<PlanDoc | null> => {
120
+ return await getPlansCollection().findOneAndUpdate(
121
+ { _id: planId },
122
+ {
123
+ $set: {
124
+ ...updates,
125
+ updatedAt: new Date(),
126
+ },
127
+ },
128
+ {
129
+ returnDocument: "after",
130
+ },
131
+ );
132
+ };
@@ -1,89 +1,89 @@
1
- import { Sort, ObjectId, WithId } from "mongodb";
2
-
3
- export const CURRENCY_CODES = ["ILS", "USD", "EUR"] as const;
4
- export type CurrencyCode = (typeof CURRENCY_CODES)[number];
5
-
6
- /** Required fields for creating a new plan */
7
- export const PLAN_REQUIRED_FIELDS = [
8
- "productKey",
9
- "name",
10
- "monthlyCallQuota",
11
- "currency",
12
- "priceMonthlyMinor",
13
- "isActive",
14
- ];
15
-
16
- /** All allowed fields that can be set/updated on a plan (excluding system fields) */
17
- export const PLAN_ALLOWED_FIELDS = [
18
- "productKey",
19
- "name",
20
- "monthlyCallQuota",
21
- "currency",
22
- "priceMonthlyMinor",
23
- "region",
24
- "countryCode",
25
- "isActive",
26
- "originalPlanId",
27
- "tax",
28
- "metadata",
29
- "updatedAt",
30
- ];
31
-
32
- /** Logical product family, like "basic-500". Multiple regional variants can share it. */
33
- export type ProductKey =
34
- | "basic-500"
35
- | "pro-1100"
36
- | "scale-6000"
37
- | (string & {});
38
-
39
- /** Optional targeting to keep variants explicit */
40
- export type RegionCode = "IL" | "EU" | "US" | (string & {});
41
- export type CountryCode = "IL" | "DE" | "FR" | "ES" | "GB" | (string & {});
42
-
43
- export type Tax = {
44
- vatIncluded: boolean;
45
- vatRatePct: number;
46
- countryCode?: CountryCode;
47
- };
48
-
49
- export type Plan = {
50
- productKey: ProductKey;
51
- name: string;
52
- monthlyCallQuota: number;
53
- currency: CurrencyCode;
54
- priceMonthlyMinor: number;
55
- region?: RegionCode;
56
- countryCode?: CountryCode;
57
- isActive: boolean;
58
- isFree?: boolean;
59
- createdAt: Date;
60
- updatedAt: Date;
61
- originalPlanId?: string;
62
- tax?: Tax;
63
- metadata?: Record<string, unknown>;
64
- };
65
-
66
- export type SimplePlanFilter = {
67
- _id?: ObjectId | string;
68
- productKey?: ProductKey;
69
- isActive?: boolean;
70
- currency?: CurrencyCode;
71
- region?: RegionCode;
72
- countryCode?: CountryCode;
73
- originalPlanId?: string;
74
- };
75
-
76
- export type PlanFilter = SimplePlanFilter & {
77
- or?: SimplePlanFilter[];
78
- and?: SimplePlanFilter[];
79
- };
80
-
81
- export type PlanQueryOptions = {
82
- sort?: Sort;
83
- skip?: number;
84
- limit?: number;
85
- };
86
-
87
- // Convenient aliases
88
- export type PlanDoc = WithId<Plan>;
89
- export type Plans = PlanDoc[];
1
+ import { Sort, ObjectId, WithId } from "mongodb";
2
+
3
+ export const CURRENCY_CODES = ["ILS", "USD", "EUR"] as const;
4
+ export type CurrencyCode = (typeof CURRENCY_CODES)[number];
5
+
6
+ /** Required fields for creating a new plan */
7
+ export const PLAN_REQUIRED_FIELDS = [
8
+ "productKey",
9
+ "name",
10
+ "monthlyCallQuota",
11
+ "currency",
12
+ "priceMonthlyMinor",
13
+ "isActive",
14
+ ];
15
+
16
+ /** All allowed fields that can be set/updated on a plan (excluding system fields) */
17
+ export const PLAN_ALLOWED_FIELDS = [
18
+ "productKey",
19
+ "name",
20
+ "monthlyCallQuota",
21
+ "currency",
22
+ "priceMonthlyMinor",
23
+ "region",
24
+ "countryCode",
25
+ "isActive",
26
+ "originalPlanId",
27
+ "tax",
28
+ "metadata",
29
+ "updatedAt",
30
+ ];
31
+
32
+ /** Logical product family, like "basic-500". Multiple regional variants can share it. */
33
+ export type ProductKey =
34
+ | "basic-500"
35
+ | "pro-1100"
36
+ | "scale-6000"
37
+ | (string & {});
38
+
39
+ /** Optional targeting to keep variants explicit */
40
+ export type RegionCode = "IL" | "EU" | "US" | (string & {});
41
+ export type CountryCode = "IL" | "DE" | "FR" | "ES" | "GB" | (string & {});
42
+
43
+ export type Tax = {
44
+ vatIncluded: boolean;
45
+ vatRatePct: number;
46
+ countryCode?: CountryCode;
47
+ };
48
+
49
+ export type Plan = {
50
+ productKey: ProductKey;
51
+ name: string;
52
+ monthlyCallQuota: number;
53
+ currency: CurrencyCode;
54
+ priceMonthlyMinor: number;
55
+ region?: RegionCode;
56
+ countryCode?: CountryCode;
57
+ isActive: boolean;
58
+ isFree?: boolean;
59
+ createdAt: Date;
60
+ updatedAt: Date;
61
+ originalPlanId?: string;
62
+ tax?: Tax;
63
+ metadata?: Record<string, unknown>;
64
+ };
65
+
66
+ export type SimplePlanFilter = {
67
+ _id?: ObjectId | string;
68
+ productKey?: ProductKey;
69
+ isActive?: boolean;
70
+ currency?: CurrencyCode;
71
+ region?: RegionCode;
72
+ countryCode?: CountryCode;
73
+ originalPlanId?: string;
74
+ };
75
+
76
+ export type PlanFilter = SimplePlanFilter & {
77
+ or?: SimplePlanFilter[];
78
+ and?: SimplePlanFilter[];
79
+ };
80
+
81
+ export type PlanQueryOptions = {
82
+ sort?: Sort;
83
+ skip?: number;
84
+ limit?: number;
85
+ };
86
+
87
+ // Convenient aliases
88
+ export type PlanDoc = WithId<Plan>;
89
+ export type Plans = PlanDoc[];
@@ -1,45 +1,45 @@
1
- import { getProductsCollection, getAllProducts } from "../products.getters";
2
- import { ObjectId } from "../../index";
3
-
4
- describe("products getters", () => {
5
- it('should return the "products" collection', () => {
6
- const collection = getProductsCollection();
7
- expect(collection.collectionName).toBe("products");
8
- });
9
-
10
- it("should return all product documents", async () => {
11
- await getProductsCollection().insertMany([
12
- { _id: new ObjectId(), name: "Municipal" },
13
- { _id: new ObjectId(), name: "Clinics" },
14
- ]);
15
-
16
- const results = await getAllProducts();
17
- expect(results.length).toBeGreaterThanOrEqual(2);
18
- expect(results.map((p) => p.name)).toEqual(
19
- expect.arrayContaining(["Municipal", "Clinics"]),
20
- );
21
- });
22
-
23
- it("should store and retrieve displayName locale map", async () => {
24
- const id = new ObjectId();
25
- await getProductsCollection().insertOne({
26
- _id: id,
27
- name: "Municipal",
28
- displayName: { he: "עירייה", en: "Municipal" },
29
- });
30
-
31
- const results = await getAllProducts();
32
- const saved = results.find((p) => p._id.equals(id));
33
- expect(saved?.displayName).toEqual({ he: "עירייה", en: "Municipal" });
34
- });
35
-
36
- it("should return products without displayName without error", async () => {
37
- const id = new ObjectId();
38
- await getProductsCollection().insertOne({ _id: id, name: "Rcure" });
39
-
40
- const results = await getAllProducts();
41
- const saved = results.find((p) => p._id.equals(id));
42
- expect(saved?.displayName).toBeUndefined();
43
- });
44
-
45
- });
1
+ import { getProductsCollection, getAllProducts } from "../products.getters";
2
+ import { ObjectId } from "../../index";
3
+
4
+ describe("products getters", () => {
5
+ it('should return the "products" collection', () => {
6
+ const collection = getProductsCollection();
7
+ expect(collection.collectionName).toBe("products");
8
+ });
9
+
10
+ it("should return all product documents", async () => {
11
+ await getProductsCollection().insertMany([
12
+ { _id: new ObjectId(), name: "Municipal" },
13
+ { _id: new ObjectId(), name: "Clinics" },
14
+ ]);
15
+
16
+ const results = await getAllProducts();
17
+ expect(results.length).toBeGreaterThanOrEqual(2);
18
+ expect(results.map((p) => p.name)).toEqual(
19
+ expect.arrayContaining(["Municipal", "Clinics"]),
20
+ );
21
+ });
22
+
23
+ it("should store and retrieve displayName locale map", async () => {
24
+ const id = new ObjectId();
25
+ await getProductsCollection().insertOne({
26
+ _id: id,
27
+ name: "Municipal",
28
+ displayName: { he: "עירייה", en: "Municipal" },
29
+ });
30
+
31
+ const results = await getAllProducts();
32
+ const saved = results.find((p) => p._id.equals(id));
33
+ expect(saved?.displayName).toEqual({ he: "עירייה", en: "Municipal" });
34
+ });
35
+
36
+ it("should return products without displayName without error", async () => {
37
+ const id = new ObjectId();
38
+ await getProductsCollection().insertOne({ _id: id, name: "Rcure" });
39
+
40
+ const results = await getAllProducts();
41
+ const saved = results.find((p) => p._id.equals(id));
42
+ expect(saved?.displayName).toBeUndefined();
43
+ });
44
+
45
+ });
@@ -1,2 +1,2 @@
1
- export * from "./products.types";
2
- export * from "./products.getters";
1
+ export * from "./products.types";
2
+ export * from "./products.getters";
@@ -1,12 +1,12 @@
1
- import { Collection, WithId } from "mongodb";
2
- import { getDb } from "../index";
3
- import type { Product } from "./products.types";
4
-
5
- export const getProductsCollection = (): Collection<Product> => {
6
- return getDb().collection<Product>("products");
7
- };
8
-
9
- /** Returns all product documents */
10
- export const getAllProducts = (): Promise<WithId<Product>[]> => {
11
- return getProductsCollection().find().toArray();
12
- };
1
+ import { Collection, WithId } from "mongodb";
2
+ import { getDb } from "../index";
3
+ import type { Product } from "./products.types";
4
+
5
+ export const getProductsCollection = (): Collection<Product> => {
6
+ return getDb().collection<Product>("products");
7
+ };
8
+
9
+ /** Returns all product documents */
10
+ export const getAllProducts = (): Promise<WithId<Product>[]> => {
11
+ return getProductsCollection().find().toArray();
12
+ };
@@ -1,9 +1,9 @@
1
- import { ObjectId } from "mongodb";
2
-
3
- export type Product = {
4
- _id: ObjectId;
5
- /** Internal product name */
6
- name: string;
7
- /** Map from language name to display name, e.g. {en, Municipal} */
8
- displayName?: Record<string, string>;
9
- };
1
+ import { ObjectId } from "mongodb";
2
+
3
+ export type Product = {
4
+ _id: ObjectId;
5
+ /** Internal product name */
6
+ name: string;
7
+ /** Map from language name to display name, e.g. {en, Municipal} */
8
+ displayName?: Record<string, string>;
9
+ };
@@ -1,7 +1,7 @@
1
- export {
2
- getResultsCollection,
3
- initializeResultDocument,
4
- findResultById,
5
- findResultByCallSid,
6
- } from "./results.getter";
7
- export type * from "./results.types";
1
+ export {
2
+ getResultsCollection,
3
+ initializeResultDocument,
4
+ findResultById,
5
+ findResultByCallSid,
6
+ } from "./results.getter";
7
+ export type * from "./results.types";