@talkpilot/core-db 1.3.84 → 1.3.85

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 (264) hide show
  1. package/.cursor/rules/development.mdc +65 -65
  2. package/AGENTS.md +49 -49
  3. package/DEVELOPMENT.md +141 -141
  4. package/README.md +846 -847
  5. package/dist/configuration/gptLive.seed.d.ts +2 -0
  6. package/dist/configuration/gptLive.seed.d.ts.map +1 -0
  7. package/dist/configuration/gptLive.seed.js +59 -0
  8. package/dist/configuration/gptLive.seed.js.map +1 -0
  9. package/dist/municipal/muniIssues/index.d.ts +2 -3
  10. package/dist/municipal/muniIssues/index.d.ts.map +1 -1
  11. package/dist/municipal/muniIssues/index.js +1 -4
  12. package/dist/municipal/muniIssues/index.js.map +1 -1
  13. package/dist/municipal/muniIssues/muniIssues.constants.d.ts +0 -2
  14. package/dist/municipal/muniIssues/muniIssues.constants.d.ts.map +1 -1
  15. package/dist/municipal/muniIssues/muniIssues.constants.js +1 -8
  16. package/dist/municipal/muniIssues/muniIssues.constants.js.map +1 -1
  17. package/dist/municipal/muniIssues/muniIssues.getters.d.ts +1 -4
  18. package/dist/municipal/muniIssues/muniIssues.getters.d.ts.map +1 -1
  19. package/dist/municipal/muniIssues/muniIssues.getters.js +1 -35
  20. package/dist/municipal/muniIssues/muniIssues.getters.js.map +1 -1
  21. package/dist/municipal/muniIssues/muniIssues.schema.d.ts.map +1 -1
  22. package/dist/municipal/muniIssues/muniIssues.schema.js +0 -17
  23. package/dist/municipal/muniIssues/muniIssues.schema.js.map +1 -1
  24. package/dist/municipal/muniIssues/muniIssues.setters.d.ts +1 -3
  25. package/dist/municipal/muniIssues/muniIssues.setters.d.ts.map +1 -1
  26. package/dist/municipal/muniIssues/muniIssues.setters.js +2 -46
  27. package/dist/municipal/muniIssues/muniIssues.setters.js.map +1 -1
  28. package/dist/municipal/muniIssues/muniIssues.types.d.ts +2 -22
  29. package/dist/municipal/muniIssues/muniIssues.types.d.ts.map +1 -1
  30. package/dist/talkpilot/clients/clients.quota.constants.d.ts +2 -0
  31. package/dist/talkpilot/clients/clients.quota.constants.d.ts.map +1 -0
  32. package/dist/talkpilot/clients/clients.quota.constants.js +5 -0
  33. package/dist/talkpilot/clients/clients.quota.constants.js.map +1 -0
  34. package/dist/talkpilot/clients/clients.quota.utils.d.ts +8 -0
  35. package/dist/talkpilot/clients/clients.quota.utils.d.ts.map +1 -0
  36. package/dist/talkpilot/clients/clients.quota.utils.js +45 -0
  37. package/dist/talkpilot/clients/clients.quota.utils.js.map +1 -0
  38. package/dist/talkpilot/contextNotes/contextNotes.getters.d.ts +7 -1
  39. package/dist/talkpilot/contextNotes/contextNotes.getters.d.ts.map +1 -1
  40. package/dist/talkpilot/contextNotes/contextNotes.getters.js +37 -1
  41. package/dist/talkpilot/contextNotes/contextNotes.getters.js.map +1 -1
  42. package/dist/talkpilot/contextNotes/contextNotes.types.d.ts +6 -0
  43. package/dist/talkpilot/contextNotes/contextNotes.types.d.ts.map +1 -1
  44. package/jest.config.js +20 -20
  45. package/package.json +46 -46
  46. package/src/__tests__/setup.ts +20 -20
  47. package/src/bulkWrite/__tests__/bulkWrite.spec.ts +65 -65
  48. package/src/bulkWrite/bulkWrite.ops.ts +45 -45
  49. package/src/bulkWrite/bulkWrite.types.ts +4 -4
  50. package/src/bulkWrite/index.ts +2 -2
  51. package/src/config.ts +9 -9
  52. package/src/configuration/index.ts +17 -17
  53. package/src/configuration/internalModels/index.ts +3 -3
  54. package/src/configuration/internalModels/internalModels.constants.ts +1 -1
  55. package/src/configuration/internalModels/internalModels.getters.ts +33 -33
  56. package/src/configuration/internalModels/internalModels.types.ts +12 -12
  57. package/src/configuration/models/__tests__/models.getters.spec.ts +67 -67
  58. package/src/configuration/models/index.ts +27 -27
  59. package/src/configuration/models/models.constants.ts +20 -20
  60. package/src/configuration/models/models.getters.ts +71 -71
  61. package/src/configuration/models/models.types.ts +80 -80
  62. package/src/configuration/mongodb-client.ts +62 -62
  63. package/src/configuration/prompts/index.ts +2 -2
  64. package/src/configuration/prompts/prompts.getters.ts +49 -49
  65. package/src/configuration/prompts/prompts.types.ts +11 -11
  66. package/src/connection.ts +81 -81
  67. package/src/index.ts +48 -48
  68. package/src/municipal/__tests__/validation.spec.ts +62 -62
  69. package/src/municipal/cities/cities.getters.ts +50 -50
  70. package/src/municipal/cities/cities.types.ts +11 -11
  71. package/src/municipal/cities/index.ts +2 -2
  72. package/src/municipal/departmentsSubjects/__tests__/departmentsSubjects.spec.ts +272 -272
  73. package/src/municipal/departmentsSubjects/departmentsSubjects.getters.ts +317 -317
  74. package/src/municipal/departmentsSubjects/departmentsSubjects.types.ts +73 -73
  75. package/src/municipal/departmentsSubjects/index.ts +9 -9
  76. package/src/municipal/index.ts +23 -23
  77. package/src/municipal/mongodb-client.ts +61 -61
  78. package/src/municipal/muniIssues/__tests__/muniIssues.setters.spec.ts +94 -219
  79. package/src/municipal/muniIssues/__tests__/muniIssues.setup.spec.ts +92 -93
  80. package/src/municipal/muniIssues/index.ts +17 -24
  81. package/src/municipal/muniIssues/muniIssues.constants.ts +18 -27
  82. package/src/municipal/muniIssues/muniIssues.getters.ts +24 -73
  83. package/src/municipal/muniIssues/muniIssues.schema.ts +66 -85
  84. package/src/municipal/muniIssues/muniIssues.setters.ts +24 -87
  85. package/src/municipal/muniIssues/muniIssues.setup.ts +65 -65
  86. package/src/municipal/muniIssues/muniIssues.types.ts +37 -67
  87. package/src/municipal/residents/__tests__/residents.spec.ts +92 -92
  88. package/src/municipal/residents/index.ts +4 -4
  89. package/src/municipal/residents/residents.constants.ts +2 -2
  90. package/src/municipal/residents/residents.getters.ts +42 -42
  91. package/src/municipal/residents/residents.schema.ts +28 -28
  92. package/src/municipal/residents/residents.types.ts +17 -17
  93. package/src/municipal/streets/__tests__/streets.spec.ts +253 -253
  94. package/src/municipal/streets/index.ts +2 -2
  95. package/src/municipal/streets/streets.getters.ts +140 -140
  96. package/src/municipal/streets/streets.types.ts +19 -19
  97. package/src/municipal/systemInstructions/__tests__/getters.spec.ts +113 -113
  98. package/src/municipal/systemInstructions/__tests__/setters.spec.ts +274 -274
  99. package/src/municipal/systemInstructions/index.ts +7 -7
  100. package/src/municipal/systemInstructions/instructions.getters.ts +57 -57
  101. package/src/municipal/systemInstructions/instructions.setters.ts +119 -119
  102. package/src/municipal/systemInstructions/instructions.types.ts +30 -30
  103. package/src/municipal/tickets/__tests__/tickets.getters.spec.ts +30 -30
  104. package/src/municipal/tickets/__tests__/tickets.statistics.spec.ts +99 -99
  105. package/src/municipal/tickets/index.ts +9 -9
  106. package/src/municipal/tickets/tickets.constants.ts +8 -8
  107. package/src/municipal/tickets/tickets.getters.ts +121 -121
  108. package/src/municipal/tickets/tickets.statistics.aggregation.ts +110 -110
  109. package/src/municipal/tickets/tickets.statistics.getters.ts +145 -145
  110. package/src/municipal/tickets/tickets.types.ts +54 -54
  111. package/src/municipal/utils/types.ts +11 -11
  112. package/src/talkpilot/__tests__/db.spec.ts +38 -38
  113. package/src/talkpilot/__tests__/mongodb-client.spec.ts +18 -18
  114. package/src/talkpilot/__tests__/validation.spec.ts +68 -68
  115. package/src/talkpilot/agents/__tests__/agents.getters.spec.ts +29 -29
  116. package/src/talkpilot/agents/agents.getters.ts +34 -34
  117. package/src/talkpilot/agents/agents.types.ts +14 -14
  118. package/src/talkpilot/agents/index.ts +2 -2
  119. package/src/talkpilot/backgroundToolResults/__tests__/backgroundToolResults.getters.spec.ts +147 -147
  120. package/src/talkpilot/backgroundToolResults/backgroundToolResults.getters.ts +65 -65
  121. package/src/talkpilot/backgroundToolResults/backgroundToolResults.types.ts +23 -23
  122. package/src/talkpilot/backgroundToolResults/index.ts +2 -2
  123. package/src/talkpilot/callTokenUsage/__tests__/callTokenUsage.getters.spec.ts +57 -57
  124. package/src/talkpilot/callTokenUsage/callTokenUsage.getters.ts +42 -42
  125. package/src/talkpilot/callTokenUsage/callTokenUsage.types.ts +28 -28
  126. package/src/talkpilot/callTokenUsage/index.ts +2 -2
  127. package/src/talkpilot/calls/__tests__/callStats.utils.spec.ts +128 -128
  128. package/src/talkpilot/calls/__tests__/calls.dashboard.spec.ts +229 -229
  129. package/src/talkpilot/calls/__tests__/calls.spec.ts +519 -519
  130. package/src/talkpilot/calls/__tests__/calls.statistics.spec.ts +483 -483
  131. package/src/talkpilot/calls/calls.constants.ts +57 -57
  132. package/src/talkpilot/calls/calls.getters.ts +295 -295
  133. package/src/talkpilot/calls/calls.statistics.getters.ts +668 -668
  134. package/src/talkpilot/calls/calls.statistics.types.ts +48 -48
  135. package/src/talkpilot/calls/calls.types.ts +168 -168
  136. package/src/talkpilot/calls/dashboard/calls.dashboard.ts +295 -295
  137. package/src/talkpilot/calls/dashboard/calls.dashboard.types.ts +57 -57
  138. package/src/talkpilot/calls/index.ts +6 -6
  139. package/src/talkpilot/clientAudioBuffers/__tests__/clientAudioBuffer.getters.spec.ts +160 -160
  140. package/src/talkpilot/clientAudioBuffers/clientAudioBuffer.getters.ts +117 -117
  141. package/src/talkpilot/clientAudioBuffers/clientsAudioBuffers.types.ts +25 -25
  142. package/src/talkpilot/clientAudioBuffers/index.ts +2 -2
  143. package/src/talkpilot/clients/__tests__/clients.quota.spec.ts +123 -123
  144. package/src/talkpilot/clients/clients.getters.ts +19 -19
  145. package/src/talkpilot/clients/clients.quota.getters.ts +119 -119
  146. package/src/talkpilot/clients/clients.quota.types.ts +27 -27
  147. package/src/talkpilot/clients/clients.types.ts +18 -18
  148. package/src/talkpilot/clients/index.ts +4 -4
  149. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.getters.spec.ts +423 -423
  150. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.spec.ts +212 -212
  151. package/src/talkpilot/clientsConfig/clientsConfig.constants.ts +2 -2
  152. package/src/talkpilot/clientsConfig/clientsConfig.getters.ts +247 -247
  153. package/src/talkpilot/clientsConfig/clientsConfig.types.ts +137 -137
  154. package/src/talkpilot/clientsConfig/index.ts +3 -3
  155. package/src/talkpilot/contextNotes/__tests__/contextNotes.getters.spec.ts +358 -217
  156. package/src/talkpilot/contextNotes/contextNotes.getters.ts +159 -85
  157. package/src/talkpilot/contextNotes/contextNotes.types.ts +27 -20
  158. package/src/talkpilot/contextNotes/index.ts +2 -2
  159. package/src/talkpilot/flows/__tests__/flows.schema.spec.ts +152 -152
  160. package/src/talkpilot/flows/flows.getter.ts +34 -34
  161. package/src/talkpilot/flows/flows.schema.ts +196 -196
  162. package/src/talkpilot/flows/flows.types.ts +220 -220
  163. package/src/talkpilot/flows/index.ts +7 -7
  164. package/src/talkpilot/groups/__tests__/groups.spec.ts +90 -90
  165. package/src/talkpilot/groups/__tests__/phone.utils.spec.ts +32 -32
  166. package/src/talkpilot/groups/groups.getters.ts +30 -30
  167. package/src/talkpilot/groups/groups.types.ts +29 -29
  168. package/src/talkpilot/groups/index.ts +3 -3
  169. package/src/talkpilot/groups/phone.utils.ts +46 -46
  170. package/src/talkpilot/index.ts +32 -32
  171. package/src/talkpilot/leads/index.ts +2 -2
  172. package/src/talkpilot/leads/leads.getter.ts +6 -6
  173. package/src/talkpilot/leads/leads.schema.ts +33 -33
  174. package/src/talkpilot/leads/leads.types.ts +20 -20
  175. package/src/talkpilot/mongodb-client.ts +78 -78
  176. package/src/talkpilot/phone_numbers/__tests__/phone_numbers.spec.ts +530 -530
  177. package/src/talkpilot/phone_numbers/index.ts +2 -2
  178. package/src/talkpilot/phone_numbers/phone_numbers.getter.ts +240 -240
  179. package/src/talkpilot/phone_numbers/phone_numbers.schema.ts +17 -17
  180. package/src/talkpilot/phone_numbers/phone_numbers.types.ts +30 -30
  181. package/src/talkpilot/phone_numbers/phone_numbers.utils.ts +9 -9
  182. package/src/talkpilot/plans/__tests__/plans.spec.ts +70 -70
  183. package/src/talkpilot/plans/index.ts +2 -2
  184. package/src/talkpilot/plans/plans.getters.ts +132 -132
  185. package/src/talkpilot/plans/plans.types.ts +89 -89
  186. package/src/talkpilot/products/__tests__/products.getters.spec.ts +44 -44
  187. package/src/talkpilot/products/index.ts +2 -2
  188. package/src/talkpilot/products/products.getters.ts +12 -12
  189. package/src/talkpilot/products/products.types.ts +9 -9
  190. package/src/talkpilot/results/index.ts +7 -7
  191. package/src/talkpilot/results/results.getter.ts +39 -39
  192. package/src/talkpilot/results/results.schema.ts +25 -25
  193. package/src/talkpilot/results/results.types.ts +34 -34
  194. package/src/talkpilot/retry_analyze/__tests__/retryAnalyze.getters.spec.ts +156 -156
  195. package/src/talkpilot/retry_analyze/index.ts +2 -2
  196. package/src/talkpilot/retry_analyze/retryAnalyze.getters.ts +84 -84
  197. package/src/talkpilot/retry_analyze/retryAnalyze.types.ts +13 -13
  198. package/src/talkpilot/sessions/__tests__/sessions.spec.ts +147 -147
  199. package/src/talkpilot/sessions/index.ts +2 -2
  200. package/src/talkpilot/sessions/sessions.getter.ts +92 -92
  201. package/src/talkpilot/sessions/sessions.schema.ts +34 -34
  202. package/src/talkpilot/sessions/sessions.types.ts +30 -30
  203. package/src/talkpilot/subscriptions/__tests__/subscriptions.getters.utils.spec.ts +45 -45
  204. package/src/talkpilot/subscriptions/index.ts +3 -3
  205. package/src/talkpilot/subscriptions/subscriptions.getters.ts +146 -146
  206. package/src/talkpilot/subscriptions/subscriptions.getters.utils.ts +33 -33
  207. package/src/talkpilot/subscriptions/subscriptions.types.ts +66 -66
  208. package/src/talkpilot/utils/__tests__/query.utils.spec.ts +49 -49
  209. package/src/talkpilot/utils/query.utils.ts +21 -21
  210. package/src/test-utils/db-utils.ts +33 -33
  211. package/src/test-utils/factories/index.ts +19 -19
  212. package/src/test-utils/factories/municipal/cities.ts +16 -16
  213. package/src/test-utils/factories/municipal/departmentsSubjects.ts +37 -37
  214. package/src/test-utils/factories/municipal/muniIssues.ts +32 -32
  215. package/src/test-utils/factories/municipal/residents.ts +20 -20
  216. package/src/test-utils/factories/municipal/streets.ts +22 -22
  217. package/src/test-utils/factories/municipal/tickets.ts +39 -39
  218. package/src/test-utils/factories/talkpilot/agents.ts +19 -19
  219. package/src/test-utils/factories/talkpilot/calls.ts +37 -37
  220. package/src/test-utils/factories/talkpilot/clientAudioBuffers.ts +20 -20
  221. package/src/test-utils/factories/talkpilot/clientsConfig.ts +18 -18
  222. package/src/test-utils/factories/talkpilot/contextNotes.ts +40 -40
  223. package/src/test-utils/factories/talkpilot/flows.ts +33 -33
  224. package/src/test-utils/factories/talkpilot/groups.ts +33 -33
  225. package/src/test-utils/factories/talkpilot/phone_numbers.ts +22 -22
  226. package/src/test-utils/factories/talkpilot/sessions.ts +35 -35
  227. package/src/test-utils/factories/websitalk/knowledgeDocuments.ts +29 -29
  228. package/src/test-utils/factories/websitalk/scanResources.ts +26 -26
  229. package/src/test-utils/factories/websitalk/scans.ts +30 -30
  230. package/src/test-utils/factories/websitalk/websiteUrls.ts +17 -17
  231. package/src/utils/date.utils.ts +126 -126
  232. package/src/utils/shared.types.ts +4 -4
  233. package/src/utils/validation.ts +23 -23
  234. package/src/websitalk/index.ts +18 -18
  235. package/src/websitalk/knowledgeDocuments/__tests__/knowledgeDocuments.spec.ts +238 -238
  236. package/src/websitalk/knowledgeDocuments/index.ts +3 -3
  237. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.constants.ts +26 -26
  238. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.getters.ts +95 -95
  239. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.types.ts +75 -75
  240. package/src/websitalk/mongodb-client.ts +61 -61
  241. package/src/websitalk/scanResources/__tests__/scanResources.spec.ts +267 -267
  242. package/src/websitalk/scanResources/index.ts +4 -4
  243. package/src/websitalk/scanResources/scanResources.constants.ts +60 -60
  244. package/src/websitalk/scanResources/scanResources.getters.ts +128 -128
  245. package/src/websitalk/scanResources/scanResources.types.ts +105 -105
  246. package/src/websitalk/scanResources/scanResources.utils.ts +31 -31
  247. package/src/websitalk/scans/__tests__/scans.spec.ts +362 -362
  248. package/src/websitalk/scans/index.ts +4 -4
  249. package/src/websitalk/scans/scans.constants.ts +18 -18
  250. package/src/websitalk/scans/scans.getters.ts +172 -172
  251. package/src/websitalk/scans/scans.types.ts +58 -58
  252. package/src/websitalk/scans/scans.utils.ts +5 -5
  253. package/src/websitalk/websiteUrls/__tests__/websiteUrls.spec.ts +77 -77
  254. package/src/websitalk/websiteUrls/index.ts +2 -2
  255. package/src/websitalk/websiteUrls/websiteUrls.getters.ts +65 -65
  256. package/src/websitalk/websiteUrls/websiteUrls.types.ts +13 -13
  257. package/tsconfig.json +23 -23
  258. package/dist/municipal/muniIssues/muniIssues.utils.d.ts +0 -3
  259. package/dist/municipal/muniIssues/muniIssues.utils.d.ts.map +0 -1
  260. package/dist/municipal/muniIssues/muniIssues.utils.js +0 -6
  261. package/dist/municipal/muniIssues/muniIssues.utils.js.map +0 -1
  262. package/src/municipal/muniIssues/__tests__/muniIssues.getters.spec.ts +0 -87
  263. package/src/municipal/muniIssues/__tests__/muniIssues.utils.spec.ts +0 -17
  264. package/src/municipal/muniIssues/muniIssues.utils.ts +0 -6
@@ -1,220 +1,220 @@
1
- import { ObjectId } from "mongodb";
2
-
3
- /* ---------- Basic helpers ---------- */
4
-
5
- export type Position = { x: number; y: number };
6
- export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
7
-
8
- export type QuestionType = "open" | "multiple" | "table";
9
- export type SelectionType = "single" | "multiple";
10
-
11
- export type Question = {
12
- id: string;
13
- type: QuestionType;
14
- text: string;
15
- repeatAnswer?: boolean;
16
- // For 'multiple' type questions:
17
- answers?: string[] | null;
18
- selectionType?: SelectionType | null; // 'single' = choose one, 'multiple' = choose one or more
19
- // For 'table' type questions:
20
- tableHeader?: string | null;
21
- tableRows?: string[] | null;
22
- tableColumns?: string[] | null; // These are the answer options shared across all rows
23
- // Note: 'table' questions can also have selectionType to indicate if each row allows single or multiple selections
24
- };
25
-
26
- export type NodeKind =
27
- | "start"
28
- | "say"
29
- | "condition"
30
- | "improvise"
31
- | "tool"
32
- | "sendMessage"
33
- | "questionsList"
34
- | "end";
35
- type BaseNode = {
36
- id: string;
37
- type: NodeKind;
38
- text: string;
39
-
40
- name?: string | null;
41
- position: Position;
42
- children?: string[] | null;
43
- successStatus?: string | null;
44
- questions?: Question[] | null;
45
- };
46
-
47
- export type StartNode = BaseNode & { type: "start" };
48
-
49
- export type SayNode = BaseNode & { type: "say" };
50
-
51
- export type ConditionNode = BaseNode & {
52
- type: "condition";
53
- conditions: Array<{
54
- conditionString: string;
55
- nodeType?: string | null;
56
- id?: string | null;
57
- }>;
58
- defaultNodeType?: string | null;
59
- defaultChild?: { id?: string } | null;
60
- };
61
-
62
- export type ImproviseNode = BaseNode & { type: "improvise" };
63
-
64
- export type FlowTool = {
65
- id: string;
66
- name: string;
67
- description?: string;
68
- url: string;
69
- method: HttpMethod;
70
- headers?: Record<string, string>;
71
- parameters: Record<string, unknown>;
72
- bodyFormat?: "json" | "form-data";
73
- preventAudioDuringTool?: boolean;
74
- /** When true, prefer cached transcription from Redis (default: false). */
75
- useRedisTranscription?: boolean;
76
- sendUserAuthToken?: boolean;
77
- runInBackground?: boolean;
78
- backgroundToolType?: "backgroundToolAlways" | "backgroundToolOnce";
79
- backgroundContinuationInstructions?: string;
80
- };
81
-
82
- export type SendMethod = "sms" | "whatsapp";
83
-
84
- export type SendMessageNode = BaseNode & {
85
- type: "sendMessage";
86
- /** Which channel to use. If omitted, decide at runtime (e.g., default to whatsapp). */
87
- send_method: SendMethod;
88
- /** Destination phone (E.164 or templated string like "{{userPhone}}"). */
89
- phone_number: string;
90
- };
91
-
92
- export type ToolNode = BaseNode & {
93
- type: "tool";
94
- name: string;
95
- text: string;
96
- };
97
-
98
- export type QuestionsListNode = BaseNode & {
99
- type: "questionsList";
100
- questions: Question[];
101
- };
102
-
103
- export type EndNode = BaseNode & { type: "end" };
104
-
105
- export type Interaction =
106
- | StartNode
107
- | SayNode
108
- | ConditionNode
109
- | ImproviseNode
110
- | ToolNode
111
- | SendMessageNode
112
- | QuestionsListNode
113
- | EndNode;
114
-
115
- export type Edge = {
116
- id: string;
117
- source: string;
118
- target: string;
119
- label?: string | null;
120
- };
121
-
122
- export type MetaKey = {
123
- key: string;
124
- required?: boolean;
125
- };
126
-
127
- export type UserProperty = {
128
- name: string;
129
- description: string;
130
- };
131
-
132
- export type InterruptionSettings = {
133
- enableInterruptionDetection?: boolean;
134
- interruptionWindowSeconds?: number;
135
- interruptionThresholdSeconds?: number;
136
- interruptionInstruction?: string;
137
- };
138
-
139
- export type SilenceEscalationSettings = {
140
- enableSilenceDetection?: boolean;
141
- firstWarningSilenceSeconds?: number;
142
- firstWarningInstruction?: string;
143
- secondWarningSilenceSeconds?: number;
144
- secondWarningInstruction?: string;
145
- disconnectSilenceSeconds?: number;
146
- silenceTimeoutSeconds?: number;
147
- };
148
-
149
- export type ConversationSettings = {
150
- interruptions?: InterruptionSettings;
151
- silence?: SilenceEscalationSettings;
152
- liveTimeUpdates?: boolean;
153
- };
154
-
155
- /* ---------- Internal tools ---------- */
156
-
157
- export type InternalToolParamConfig = {
158
- description?: string;
159
- /** Pinned value. When set, the agent is not asked for this parameter. */
160
- value?: string | number | boolean | string[];
161
- };
162
-
163
- export type InternalToolConfig = {
164
- enabled: boolean;
165
- /** Max invocations per call. Unlimited when omitted. */
166
- maxCalls?: number;
167
- params?: Record<string, InternalToolParamConfig>;
168
- };
169
-
170
- export type BeforeCallEvent = {
171
- url: string;
172
- timeoutMs?: number;
173
- sendUserAuthToken?: boolean;
174
- allowedKeys?: string[];
175
- wait?: boolean;
176
- };
177
-
178
- /* ---------- The Flow object ---------- */
179
-
180
- export type Flow = {
181
- freeTextContent?: string;
182
- isFreeText?: boolean;
183
- disableGenericPrompt?: boolean;
184
- _id?: ObjectId;
185
-
186
- flowName: string;
187
- clientId: string;
188
-
189
- systemInstructions: string;
190
- initialSentence: string;
191
- voice?: string;
192
-
193
- insights: string[];
194
- conversationSettings?: ConversationSettings;
195
-
196
- interactions: Interaction[];
197
-
198
- edges?: Edge[] | null;
199
- metaKeys?: MetaKey[] | null;
200
- userProperties?: UserProperty[] | null;
201
- tools?: FlowTool[];
202
- beforeCallEvent?: BeforeCallEvent;
203
- afterCallEvent?: string;
204
-
205
- products?: string[];
206
-
207
- // AI provider configuration
208
- aiProvider?: any;
209
-
210
- /** Internal tool toggles and per-parameter overrides, keyed by tool name. */
211
- internalTools?: Record<string, InternalToolConfig>;
212
-
213
- // Timestamps
214
- createdAt?: Date;
215
- updatedAt?: Date;
216
- };
217
-
218
- export type FlowUpdateParams = Partial<
219
- Omit<Flow, "_id" | "clientId" | "createdAt">
220
- >;
1
+ import { ObjectId } from "mongodb";
2
+
3
+ /* ---------- Basic helpers ---------- */
4
+
5
+ export type Position = { x: number; y: number };
6
+ export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
7
+
8
+ export type QuestionType = "open" | "multiple" | "table";
9
+ export type SelectionType = "single" | "multiple";
10
+
11
+ export type Question = {
12
+ id: string;
13
+ type: QuestionType;
14
+ text: string;
15
+ repeatAnswer?: boolean;
16
+ // For 'multiple' type questions:
17
+ answers?: string[] | null;
18
+ selectionType?: SelectionType | null; // 'single' = choose one, 'multiple' = choose one or more
19
+ // For 'table' type questions:
20
+ tableHeader?: string | null;
21
+ tableRows?: string[] | null;
22
+ tableColumns?: string[] | null; // These are the answer options shared across all rows
23
+ // Note: 'table' questions can also have selectionType to indicate if each row allows single or multiple selections
24
+ };
25
+
26
+ export type NodeKind =
27
+ | "start"
28
+ | "say"
29
+ | "condition"
30
+ | "improvise"
31
+ | "tool"
32
+ | "sendMessage"
33
+ | "questionsList"
34
+ | "end";
35
+ type BaseNode = {
36
+ id: string;
37
+ type: NodeKind;
38
+ text: string;
39
+
40
+ name?: string | null;
41
+ position: Position;
42
+ children?: string[] | null;
43
+ successStatus?: string | null;
44
+ questions?: Question[] | null;
45
+ };
46
+
47
+ export type StartNode = BaseNode & { type: "start" };
48
+
49
+ export type SayNode = BaseNode & { type: "say" };
50
+
51
+ export type ConditionNode = BaseNode & {
52
+ type: "condition";
53
+ conditions: Array<{
54
+ conditionString: string;
55
+ nodeType?: string | null;
56
+ id?: string | null;
57
+ }>;
58
+ defaultNodeType?: string | null;
59
+ defaultChild?: { id?: string } | null;
60
+ };
61
+
62
+ export type ImproviseNode = BaseNode & { type: "improvise" };
63
+
64
+ export type FlowTool = {
65
+ id: string;
66
+ name: string;
67
+ description?: string;
68
+ url: string;
69
+ method: HttpMethod;
70
+ headers?: Record<string, string>;
71
+ parameters: Record<string, unknown>;
72
+ bodyFormat?: "json" | "form-data";
73
+ preventAudioDuringTool?: boolean;
74
+ /** When true, prefer cached transcription from Redis (default: false). */
75
+ useRedisTranscription?: boolean;
76
+ sendUserAuthToken?: boolean;
77
+ runInBackground?: boolean;
78
+ backgroundToolType?: "backgroundToolAlways" | "backgroundToolOnce";
79
+ backgroundContinuationInstructions?: string;
80
+ };
81
+
82
+ export type SendMethod = "sms" | "whatsapp";
83
+
84
+ export type SendMessageNode = BaseNode & {
85
+ type: "sendMessage";
86
+ /** Which channel to use. If omitted, decide at runtime (e.g., default to whatsapp). */
87
+ send_method: SendMethod;
88
+ /** Destination phone (E.164 or templated string like "{{userPhone}}"). */
89
+ phone_number: string;
90
+ };
91
+
92
+ export type ToolNode = BaseNode & {
93
+ type: "tool";
94
+ name: string;
95
+ text: string;
96
+ };
97
+
98
+ export type QuestionsListNode = BaseNode & {
99
+ type: "questionsList";
100
+ questions: Question[];
101
+ };
102
+
103
+ export type EndNode = BaseNode & { type: "end" };
104
+
105
+ export type Interaction =
106
+ | StartNode
107
+ | SayNode
108
+ | ConditionNode
109
+ | ImproviseNode
110
+ | ToolNode
111
+ | SendMessageNode
112
+ | QuestionsListNode
113
+ | EndNode;
114
+
115
+ export type Edge = {
116
+ id: string;
117
+ source: string;
118
+ target: string;
119
+ label?: string | null;
120
+ };
121
+
122
+ export type MetaKey = {
123
+ key: string;
124
+ required?: boolean;
125
+ };
126
+
127
+ export type UserProperty = {
128
+ name: string;
129
+ description: string;
130
+ };
131
+
132
+ export type InterruptionSettings = {
133
+ enableInterruptionDetection?: boolean;
134
+ interruptionWindowSeconds?: number;
135
+ interruptionThresholdSeconds?: number;
136
+ interruptionInstruction?: string;
137
+ };
138
+
139
+ export type SilenceEscalationSettings = {
140
+ enableSilenceDetection?: boolean;
141
+ firstWarningSilenceSeconds?: number;
142
+ firstWarningInstruction?: string;
143
+ secondWarningSilenceSeconds?: number;
144
+ secondWarningInstruction?: string;
145
+ disconnectSilenceSeconds?: number;
146
+ silenceTimeoutSeconds?: number;
147
+ };
148
+
149
+ export type ConversationSettings = {
150
+ interruptions?: InterruptionSettings;
151
+ silence?: SilenceEscalationSettings;
152
+ liveTimeUpdates?: boolean;
153
+ };
154
+
155
+ /* ---------- Internal tools ---------- */
156
+
157
+ export type InternalToolParamConfig = {
158
+ description?: string;
159
+ /** Pinned value. When set, the agent is not asked for this parameter. */
160
+ value?: string | number | boolean | string[];
161
+ };
162
+
163
+ export type InternalToolConfig = {
164
+ enabled: boolean;
165
+ /** Max invocations per call. Unlimited when omitted. */
166
+ maxCalls?: number;
167
+ params?: Record<string, InternalToolParamConfig>;
168
+ };
169
+
170
+ export type BeforeCallEvent = {
171
+ url: string;
172
+ timeoutMs?: number;
173
+ sendUserAuthToken?: boolean;
174
+ allowedKeys?: string[];
175
+ wait?: boolean;
176
+ };
177
+
178
+ /* ---------- The Flow object ---------- */
179
+
180
+ export type Flow = {
181
+ freeTextContent?: string;
182
+ isFreeText?: boolean;
183
+ disableGenericPrompt?: boolean;
184
+ _id?: ObjectId;
185
+
186
+ flowName: string;
187
+ clientId: string;
188
+
189
+ systemInstructions: string;
190
+ initialSentence: string;
191
+ voice?: string;
192
+
193
+ insights: string[];
194
+ conversationSettings?: ConversationSettings;
195
+
196
+ interactions: Interaction[];
197
+
198
+ edges?: Edge[] | null;
199
+ metaKeys?: MetaKey[] | null;
200
+ userProperties?: UserProperty[] | null;
201
+ tools?: FlowTool[];
202
+ beforeCallEvent?: BeforeCallEvent;
203
+ afterCallEvent?: string;
204
+
205
+ products?: string[];
206
+
207
+ // AI provider configuration
208
+ aiProvider?: any;
209
+
210
+ /** Internal tool toggles and per-parameter overrides, keyed by tool name. */
211
+ internalTools?: Record<string, InternalToolConfig>;
212
+
213
+ // Timestamps
214
+ createdAt?: Date;
215
+ updatedAt?: Date;
216
+ };
217
+
218
+ export type FlowUpdateParams = Partial<
219
+ Omit<Flow, "_id" | "clientId" | "createdAt">
220
+ >;
@@ -1,7 +1,7 @@
1
- export {
2
- getFlowsCollection,
3
- findFlowById,
4
- createFlow,
5
- updateFlowById,
6
- } from "./flows.getter";
7
- export type * from "./flows.types";
1
+ export {
2
+ getFlowsCollection,
3
+ findFlowById,
4
+ createFlow,
5
+ updateFlowById,
6
+ } from "./flows.getter";
7
+ export type * from "./flows.types";
@@ -1,90 +1,90 @@
1
- import { ObjectId } from "mongodb";
2
- import { faker } from "@faker-js/faker";
3
- import {
4
- getGroupsCollection,
5
- findGroups,
6
- createGroup,
7
- updateGroup,
8
- removeGroup,
9
- } from "../groups.getters";
10
- import { createGroup as createGroupDoc } from "../../../test-utils/factories";
11
-
12
- describe("db.groups", () => {
13
- describe("getGroupsCollection", () => {
14
- it('returns the "groups" collection', () => {
15
- expect(getGroupsCollection().collectionName).toBe("groups");
16
- });
17
- });
18
-
19
- describe("findGroups", () => {
20
- it("returns groups matching the provided filter", async () => {
21
- const clientId = faker.string.uuid();
22
- const g1 = createGroupDoc({ clientId, name: "Group A" });
23
- const g2 = createGroupDoc({ clientId, name: "Group B" });
24
- const gOther = createGroupDoc({
25
- clientId: faker.string.uuid(),
26
- name: "Group C",
27
- });
28
-
29
- await getGroupsCollection().insertMany([g1, g2, gOther]);
30
-
31
- const result = await findGroups({ clientId });
32
- const names = result.map((g) => g.name).sort();
33
-
34
- expect(result).toHaveLength(2);
35
- expect(names).toEqual(["Group A", "Group B"]);
36
- });
37
- });
38
-
39
- describe("createGroup", () => {
40
- it("inserts a group and returns insertedId", async () => {
41
- const toInsert = createGroupDoc({ name: "New Group" });
42
-
43
- const insertedId = await createGroup(toInsert);
44
- expect(insertedId).toBeInstanceOf(ObjectId);
45
-
46
- const fromDb = await getGroupsCollection().findOne({ _id: insertedId });
47
- expect(fromDb?.name).toBe("New Group");
48
- expect(fromDb?.clientId).toBe(toInsert.clientId);
49
- });
50
- });
51
-
52
- describe("updateGroup", () => {
53
- it("updates the group and sets updatedAt, returning the updated document", async () => {
54
- const original = createGroupDoc({
55
- name: "Before",
56
- description: "Old desc",
57
- });
58
- const { insertedId } = await getGroupsCollection().insertOne(original);
59
- const before = await getGroupsCollection().findOne({ _id: insertedId });
60
-
61
- // Add a small delay to ensure updatedAt will be different
62
- await new Promise((resolve) => setTimeout(resolve, 10));
63
-
64
- const res = await updateGroup(
65
- { _id: insertedId },
66
- { name: "After", description: "New desc" },
67
- );
68
-
69
- expect(res?._id).toEqual(insertedId);
70
- expect(res?.name).toBe("After");
71
- expect(res?.description).toBe("New desc");
72
- expect(new Date(res!.updatedAt).getTime()).toBeGreaterThan(
73
- new Date(before!.updatedAt).getTime(),
74
- );
75
- });
76
- });
77
-
78
- describe("removeGroup", () => {
79
- it("removes a group by string id", async () => {
80
- const { insertedId } =
81
- await getGroupsCollection().insertOne(createGroupDoc());
82
-
83
- const result = await removeGroup(insertedId.toHexString());
84
- expect(result.deletedCount).toBe(1);
85
-
86
- const check = await getGroupsCollection().findOne({ _id: insertedId });
87
- expect(check).toBeNull();
88
- });
89
- });
90
- });
1
+ import { ObjectId } from "mongodb";
2
+ import { faker } from "@faker-js/faker";
3
+ import {
4
+ getGroupsCollection,
5
+ findGroups,
6
+ createGroup,
7
+ updateGroup,
8
+ removeGroup,
9
+ } from "../groups.getters";
10
+ import { createGroup as createGroupDoc } from "../../../test-utils/factories";
11
+
12
+ describe("db.groups", () => {
13
+ describe("getGroupsCollection", () => {
14
+ it('returns the "groups" collection', () => {
15
+ expect(getGroupsCollection().collectionName).toBe("groups");
16
+ });
17
+ });
18
+
19
+ describe("findGroups", () => {
20
+ it("returns groups matching the provided filter", async () => {
21
+ const clientId = faker.string.uuid();
22
+ const g1 = createGroupDoc({ clientId, name: "Group A" });
23
+ const g2 = createGroupDoc({ clientId, name: "Group B" });
24
+ const gOther = createGroupDoc({
25
+ clientId: faker.string.uuid(),
26
+ name: "Group C",
27
+ });
28
+
29
+ await getGroupsCollection().insertMany([g1, g2, gOther]);
30
+
31
+ const result = await findGroups({ clientId });
32
+ const names = result.map((g) => g.name).sort();
33
+
34
+ expect(result).toHaveLength(2);
35
+ expect(names).toEqual(["Group A", "Group B"]);
36
+ });
37
+ });
38
+
39
+ describe("createGroup", () => {
40
+ it("inserts a group and returns insertedId", async () => {
41
+ const toInsert = createGroupDoc({ name: "New Group" });
42
+
43
+ const insertedId = await createGroup(toInsert);
44
+ expect(insertedId).toBeInstanceOf(ObjectId);
45
+
46
+ const fromDb = await getGroupsCollection().findOne({ _id: insertedId });
47
+ expect(fromDb?.name).toBe("New Group");
48
+ expect(fromDb?.clientId).toBe(toInsert.clientId);
49
+ });
50
+ });
51
+
52
+ describe("updateGroup", () => {
53
+ it("updates the group and sets updatedAt, returning the updated document", async () => {
54
+ const original = createGroupDoc({
55
+ name: "Before",
56
+ description: "Old desc",
57
+ });
58
+ const { insertedId } = await getGroupsCollection().insertOne(original);
59
+ const before = await getGroupsCollection().findOne({ _id: insertedId });
60
+
61
+ // Add a small delay to ensure updatedAt will be different
62
+ await new Promise((resolve) => setTimeout(resolve, 10));
63
+
64
+ const res = await updateGroup(
65
+ { _id: insertedId },
66
+ { name: "After", description: "New desc" },
67
+ );
68
+
69
+ expect(res?._id).toEqual(insertedId);
70
+ expect(res?.name).toBe("After");
71
+ expect(res?.description).toBe("New desc");
72
+ expect(new Date(res!.updatedAt).getTime()).toBeGreaterThan(
73
+ new Date(before!.updatedAt).getTime(),
74
+ );
75
+ });
76
+ });
77
+
78
+ describe("removeGroup", () => {
79
+ it("removes a group by string id", async () => {
80
+ const { insertedId } =
81
+ await getGroupsCollection().insertOne(createGroupDoc());
82
+
83
+ const result = await removeGroup(insertedId.toHexString());
84
+ expect(result.deletedCount).toBe(1);
85
+
86
+ const check = await getGroupsCollection().findOne({ _id: insertedId });
87
+ expect(check).toBeNull();
88
+ });
89
+ });
90
+ });