@talkpilot/core-db 1.3.50 → 1.3.51

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 (229) 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 +778 -778
  5. package/dist/configuration/models/models.constants.d.ts +1 -1
  6. package/dist/configuration/models/models.constants.d.ts.map +1 -1
  7. package/dist/configuration/models/models.constants.js +1 -6
  8. package/dist/configuration/models/models.constants.js.map +1 -1
  9. package/dist/websitalk/scanResources/scanResources.getters.d.ts +1 -0
  10. package/dist/websitalk/scanResources/scanResources.getters.d.ts.map +1 -1
  11. package/dist/websitalk/scanResources/scanResources.getters.js +6 -1
  12. package/dist/websitalk/scanResources/scanResources.getters.js.map +1 -1
  13. package/dist/websitalk/scans/scans.constants.d.ts +1 -0
  14. package/dist/websitalk/scans/scans.constants.d.ts.map +1 -1
  15. package/dist/websitalk/scans/scans.constants.js +1 -0
  16. package/dist/websitalk/scans/scans.constants.js.map +1 -1
  17. package/dist/websitalk/scans/scans.getters.d.ts +1 -0
  18. package/dist/websitalk/scans/scans.getters.d.ts.map +1 -1
  19. package/dist/websitalk/scans/scans.getters.js +6 -1
  20. package/dist/websitalk/scans/scans.getters.js.map +1 -1
  21. package/jest.config.js +20 -20
  22. package/package.json +46 -46
  23. package/src/__tests__/setup.ts +20 -20
  24. package/src/bulkWrite/__tests__/bulkWrite.spec.ts +65 -65
  25. package/src/bulkWrite/bulkWrite.ops.ts +45 -45
  26. package/src/bulkWrite/bulkWrite.types.ts +4 -4
  27. package/src/bulkWrite/index.ts +2 -2
  28. package/src/config.ts +9 -9
  29. package/src/configuration/index.ts +17 -17
  30. package/src/configuration/internalModels/index.ts +3 -3
  31. package/src/configuration/internalModels/internalModels.constants.ts +1 -1
  32. package/src/configuration/internalModels/internalModels.getters.ts +33 -33
  33. package/src/configuration/internalModels/internalModels.types.ts +12 -12
  34. package/src/configuration/models/index.ts +25 -25
  35. package/src/configuration/models/models.constants.ts +13 -18
  36. package/src/configuration/models/models.getters.ts +53 -53
  37. package/src/configuration/models/models.types.ts +79 -79
  38. package/src/configuration/mongodb-client.ts +62 -62
  39. package/src/configuration/prompts/index.ts +2 -2
  40. package/src/configuration/prompts/prompts.getters.ts +49 -49
  41. package/src/configuration/prompts/prompts.types.ts +11 -11
  42. package/src/connection.ts +81 -81
  43. package/src/index.ts +46 -46
  44. package/src/municipal/__tests__/validation.spec.ts +62 -62
  45. package/src/municipal/cities/cities.getters.ts +50 -50
  46. package/src/municipal/cities/cities.types.ts +11 -11
  47. package/src/municipal/cities/index.ts +2 -2
  48. package/src/municipal/departmentsSubjects/__tests__/departmentsSubjects.spec.ts +272 -272
  49. package/src/municipal/departmentsSubjects/departmentsSubjects.getters.ts +317 -317
  50. package/src/municipal/departmentsSubjects/departmentsSubjects.types.ts +73 -73
  51. package/src/municipal/departmentsSubjects/index.ts +9 -9
  52. package/src/municipal/index.ts +22 -22
  53. package/src/municipal/mongodb-client.ts +61 -61
  54. package/src/municipal/muniIssues/__tests__/muniIssues.setters.spec.ts +94 -94
  55. package/src/municipal/muniIssues/__tests__/muniIssues.setup.spec.ts +92 -92
  56. package/src/municipal/muniIssues/index.ts +17 -17
  57. package/src/municipal/muniIssues/muniIssues.constants.ts +18 -18
  58. package/src/municipal/muniIssues/muniIssues.getters.ts +24 -24
  59. package/src/municipal/muniIssues/muniIssues.schema.ts +66 -66
  60. package/src/municipal/muniIssues/muniIssues.setters.ts +24 -24
  61. package/src/municipal/muniIssues/muniIssues.setup.ts +65 -65
  62. package/src/municipal/muniIssues/muniIssues.types.ts +37 -37
  63. package/src/municipal/streets/__tests__/streets.spec.ts +253 -253
  64. package/src/municipal/streets/index.ts +2 -2
  65. package/src/municipal/streets/streets.getters.ts +140 -140
  66. package/src/municipal/streets/streets.types.ts +19 -19
  67. package/src/municipal/systemInstructions/__tests__/getters.spec.ts +113 -113
  68. package/src/municipal/systemInstructions/__tests__/setters.spec.ts +274 -274
  69. package/src/municipal/systemInstructions/index.ts +7 -7
  70. package/src/municipal/systemInstructions/instructions.getters.ts +57 -57
  71. package/src/municipal/systemInstructions/instructions.setters.ts +119 -119
  72. package/src/municipal/systemInstructions/instructions.types.ts +30 -30
  73. package/src/municipal/tickets/__tests__/tickets.getters.spec.ts +30 -30
  74. package/src/municipal/tickets/__tests__/tickets.statistics.spec.ts +99 -99
  75. package/src/municipal/tickets/index.ts +9 -9
  76. package/src/municipal/tickets/tickets.constants.ts +8 -8
  77. package/src/municipal/tickets/tickets.getters.ts +121 -121
  78. package/src/municipal/tickets/tickets.statistics.aggregation.ts +110 -110
  79. package/src/municipal/tickets/tickets.statistics.getters.ts +145 -145
  80. package/src/municipal/tickets/tickets.types.ts +54 -54
  81. package/src/municipal/utils/types.ts +11 -11
  82. package/src/talkpilot/__tests__/db.spec.ts +38 -38
  83. package/src/talkpilot/__tests__/mongodb-client.spec.ts +18 -18
  84. package/src/talkpilot/__tests__/validation.spec.ts +68 -68
  85. package/src/talkpilot/agents/__tests__/agents.getters.spec.ts +29 -29
  86. package/src/talkpilot/agents/agents.getters.ts +34 -34
  87. package/src/talkpilot/agents/agents.types.ts +14 -14
  88. package/src/talkpilot/agents/index.ts +2 -2
  89. package/src/talkpilot/backgroundToolResults/__tests__/backgroundToolResults.getters.spec.ts +147 -147
  90. package/src/talkpilot/backgroundToolResults/backgroundToolResults.getters.ts +65 -65
  91. package/src/talkpilot/backgroundToolResults/backgroundToolResults.types.ts +23 -23
  92. package/src/talkpilot/backgroundToolResults/index.ts +2 -2
  93. package/src/talkpilot/calls/__tests__/callStats.utils.spec.ts +128 -128
  94. package/src/talkpilot/calls/__tests__/calls.dashboard.spec.ts +229 -229
  95. package/src/talkpilot/calls/__tests__/calls.spec.ts +471 -471
  96. package/src/talkpilot/calls/__tests__/calls.statistics.spec.ts +483 -483
  97. package/src/talkpilot/calls/calls.constants.ts +49 -49
  98. package/src/talkpilot/calls/calls.getters.ts +277 -277
  99. package/src/talkpilot/calls/calls.statistics.getters.ts +668 -668
  100. package/src/talkpilot/calls/calls.statistics.types.ts +48 -48
  101. package/src/talkpilot/calls/calls.types.ts +149 -149
  102. package/src/talkpilot/calls/dashboard/calls.dashboard.ts +295 -295
  103. package/src/talkpilot/calls/dashboard/calls.dashboard.types.ts +57 -57
  104. package/src/talkpilot/calls/index.ts +6 -6
  105. package/src/talkpilot/clientAudioBuffers/__tests__/clientAudioBuffer.getters.spec.ts +160 -160
  106. package/src/talkpilot/clientAudioBuffers/clientAudioBuffer.getters.ts +117 -117
  107. package/src/talkpilot/clientAudioBuffers/clientsAudioBuffers.types.ts +25 -25
  108. package/src/talkpilot/clientAudioBuffers/index.ts +2 -2
  109. package/src/talkpilot/clients/__tests__/clients.quota.spec.ts +123 -123
  110. package/src/talkpilot/clients/clients.getters.ts +16 -16
  111. package/src/talkpilot/clients/clients.quota.getters.ts +119 -119
  112. package/src/talkpilot/clients/clients.quota.types.ts +27 -27
  113. package/src/talkpilot/clients/clients.types.ts +18 -18
  114. package/src/talkpilot/clients/index.ts +4 -4
  115. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.getters.spec.ts +423 -423
  116. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.spec.ts +212 -212
  117. package/src/talkpilot/clientsConfig/clientsConfig.constants.ts +2 -2
  118. package/src/talkpilot/clientsConfig/clientsConfig.getters.ts +247 -247
  119. package/src/talkpilot/clientsConfig/clientsConfig.types.ts +136 -136
  120. package/src/talkpilot/clientsConfig/index.ts +3 -3
  121. package/src/talkpilot/contextNotes/__tests__/contextNotes.getters.spec.ts +217 -217
  122. package/src/talkpilot/contextNotes/contextNotes.getters.ts +85 -85
  123. package/src/talkpilot/contextNotes/contextNotes.types.ts +20 -20
  124. package/src/talkpilot/contextNotes/index.ts +2 -2
  125. package/src/talkpilot/flows/__tests__/flows.schema.spec.ts +124 -124
  126. package/src/talkpilot/flows/flows.getter.ts +34 -34
  127. package/src/talkpilot/flows/flows.schema.ts +180 -180
  128. package/src/talkpilot/flows/flows.types.ts +211 -211
  129. package/src/talkpilot/flows/index.ts +7 -7
  130. package/src/talkpilot/groups/__tests__/groups.spec.ts +90 -90
  131. package/src/talkpilot/groups/__tests__/phone.utils.spec.ts +32 -32
  132. package/src/talkpilot/groups/groups.getters.ts +30 -30
  133. package/src/talkpilot/groups/groups.types.ts +29 -29
  134. package/src/talkpilot/groups/index.ts +3 -3
  135. package/src/talkpilot/groups/phone.utils.ts +46 -46
  136. package/src/talkpilot/index.ts +31 -31
  137. package/src/talkpilot/leads/index.ts +2 -2
  138. package/src/talkpilot/leads/leads.getter.ts +6 -6
  139. package/src/talkpilot/leads/leads.schema.ts +33 -33
  140. package/src/talkpilot/leads/leads.types.ts +20 -20
  141. package/src/talkpilot/mongodb-client.ts +78 -78
  142. package/src/talkpilot/phone_numbers/__tests__/phone_numbers.spec.ts +282 -282
  143. package/src/talkpilot/phone_numbers/index.ts +2 -2
  144. package/src/talkpilot/phone_numbers/phone_numbers.getter.ts +176 -176
  145. package/src/talkpilot/phone_numbers/phone_numbers.schema.ts +17 -17
  146. package/src/talkpilot/phone_numbers/phone_numbers.types.ts +30 -30
  147. package/src/talkpilot/plans/__tests__/plans.spec.ts +70 -70
  148. package/src/talkpilot/plans/index.ts +2 -2
  149. package/src/talkpilot/plans/plans.getters.ts +132 -132
  150. package/src/talkpilot/plans/plans.types.ts +89 -89
  151. package/src/talkpilot/products/__tests__/products.getters.spec.ts +44 -44
  152. package/src/talkpilot/products/index.ts +2 -2
  153. package/src/talkpilot/products/products.getters.ts +12 -12
  154. package/src/talkpilot/products/products.types.ts +9 -9
  155. package/src/talkpilot/results/index.ts +7 -7
  156. package/src/talkpilot/results/results.getter.ts +39 -39
  157. package/src/talkpilot/results/results.schema.ts +25 -25
  158. package/src/talkpilot/results/results.types.ts +34 -34
  159. package/src/talkpilot/retry_analyze/__tests__/retryAnalyze.getters.spec.ts +156 -156
  160. package/src/talkpilot/retry_analyze/index.ts +2 -2
  161. package/src/talkpilot/retry_analyze/retryAnalyze.getters.ts +84 -84
  162. package/src/talkpilot/retry_analyze/retryAnalyze.types.ts +13 -13
  163. package/src/talkpilot/sessions/__tests__/sessions.spec.ts +147 -147
  164. package/src/talkpilot/sessions/index.ts +2 -2
  165. package/src/talkpilot/sessions/sessions.getter.ts +92 -92
  166. package/src/talkpilot/sessions/sessions.schema.ts +34 -34
  167. package/src/talkpilot/sessions/sessions.types.ts +30 -30
  168. package/src/talkpilot/subscriptions/__tests__/subscriptions.getters.utils.spec.ts +45 -45
  169. package/src/talkpilot/subscriptions/index.ts +3 -3
  170. package/src/talkpilot/subscriptions/subscriptions.getters.ts +146 -146
  171. package/src/talkpilot/subscriptions/subscriptions.getters.utils.ts +33 -33
  172. package/src/talkpilot/subscriptions/subscriptions.types.ts +66 -66
  173. package/src/talkpilot/utils/__tests__/query.utils.spec.ts +49 -49
  174. package/src/talkpilot/utils/query.utils.ts +21 -21
  175. package/src/test-utils/db-utils.ts +33 -33
  176. package/src/test-utils/factories/index.ts +18 -18
  177. package/src/test-utils/factories/municipal/cities.ts +16 -16
  178. package/src/test-utils/factories/municipal/departmentsSubjects.ts +37 -37
  179. package/src/test-utils/factories/municipal/muniIssues.ts +32 -32
  180. package/src/test-utils/factories/municipal/streets.ts +22 -22
  181. package/src/test-utils/factories/municipal/tickets.ts +39 -39
  182. package/src/test-utils/factories/talkpilot/agents.ts +19 -19
  183. package/src/test-utils/factories/talkpilot/calls.ts +37 -37
  184. package/src/test-utils/factories/talkpilot/clientAudioBuffers.ts +20 -20
  185. package/src/test-utils/factories/talkpilot/clientsConfig.ts +18 -18
  186. package/src/test-utils/factories/talkpilot/contextNotes.ts +40 -40
  187. package/src/test-utils/factories/talkpilot/flows.ts +33 -33
  188. package/src/test-utils/factories/talkpilot/groups.ts +33 -33
  189. package/src/test-utils/factories/talkpilot/phone_numbers.ts +22 -22
  190. package/src/test-utils/factories/talkpilot/sessions.ts +35 -35
  191. package/src/test-utils/factories/websitalk/knowledgeDocuments.ts +29 -29
  192. package/src/test-utils/factories/websitalk/scanResources.ts +26 -26
  193. package/src/test-utils/factories/websitalk/scans.ts +29 -29
  194. package/src/test-utils/factories/websitalk/websiteUrls.ts +17 -17
  195. package/src/utils/date.utils.ts +126 -126
  196. package/src/utils/shared.types.ts +4 -4
  197. package/src/utils/validation.ts +23 -23
  198. package/src/websitalk/index.ts +18 -18
  199. package/src/websitalk/knowledgeDocuments/__tests__/knowledgeDocuments.spec.ts +186 -186
  200. package/src/websitalk/knowledgeDocuments/index.ts +3 -3
  201. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.constants.ts +17 -17
  202. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.getters.ts +78 -78
  203. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.types.ts +62 -62
  204. package/src/websitalk/mongodb-client.ts +61 -61
  205. package/src/websitalk/scanResources/__tests__/scanResources.spec.ts +212 -193
  206. package/src/websitalk/scanResources/index.ts +4 -4
  207. package/src/websitalk/scanResources/scanResources.constants.ts +47 -47
  208. package/src/websitalk/scanResources/scanResources.getters.ts +109 -102
  209. package/src/websitalk/scanResources/scanResources.types.ts +90 -90
  210. package/src/websitalk/scanResources/scanResources.utils.ts +31 -31
  211. package/src/websitalk/scans/__tests__/scans.spec.ts +330 -313
  212. package/src/websitalk/scans/index.ts +4 -4
  213. package/src/websitalk/scans/scans.constants.ts +16 -15
  214. package/src/websitalk/scans/scans.getters.ts +171 -166
  215. package/src/websitalk/scans/scans.types.ts +54 -54
  216. package/src/websitalk/scans/scans.utils.ts +5 -5
  217. package/src/websitalk/websiteUrls/__tests__/websiteUrls.spec.ts +77 -77
  218. package/src/websitalk/websiteUrls/index.ts +2 -2
  219. package/src/websitalk/websiteUrls/websiteUrls.getters.ts +65 -65
  220. package/src/websitalk/websiteUrls/websiteUrls.types.ts +13 -13
  221. package/tsconfig.json +23 -23
  222. package/dist/talkpilot/clients/clients.quota.constants.d.ts +0 -2
  223. package/dist/talkpilot/clients/clients.quota.constants.d.ts.map +0 -1
  224. package/dist/talkpilot/clients/clients.quota.constants.js +0 -5
  225. package/dist/talkpilot/clients/clients.quota.constants.js.map +0 -1
  226. package/dist/talkpilot/clients/clients.quota.utils.d.ts +0 -8
  227. package/dist/talkpilot/clients/clients.quota.utils.d.ts.map +0 -1
  228. package/dist/talkpilot/clients/clients.quota.utils.js +0 -45
  229. package/dist/talkpilot/clients/clients.quota.utils.js.map +0 -1
@@ -1,211 +1,211 @@
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
- /* ---------- The Flow object ---------- */
171
-
172
- export type Flow = {
173
- freeTextContent?: string;
174
- isFreeText?: boolean;
175
- disableGenericPrompt?: boolean;
176
- _id?: ObjectId;
177
-
178
- flowName: string;
179
- clientId: string;
180
-
181
- systemInstructions: string;
182
- initialSentence: string;
183
- voice?: string;
184
-
185
- insights: string[];
186
- conversationSettings?: ConversationSettings;
187
-
188
- interactions: Interaction[];
189
-
190
- edges?: Edge[] | null;
191
- metaKeys?: MetaKey[] | null;
192
- userProperties?: UserProperty[] | null;
193
- tools?: FlowTool[];
194
- afterCallEvent?: string;
195
-
196
- products?: string[];
197
-
198
- // AI provider configuration
199
- aiProvider?: any;
200
-
201
- /** Internal tool toggles and per-parameter overrides, keyed by tool name. */
202
- internalTools?: Record<string, InternalToolConfig>;
203
-
204
- // Timestamps
205
- createdAt?: Date;
206
- updatedAt?: Date;
207
- };
208
-
209
- export type FlowUpdateParams = Partial<
210
- Omit<Flow, "_id" | "clientId" | "createdAt">
211
- >;
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
+ /* ---------- The Flow object ---------- */
171
+
172
+ export type Flow = {
173
+ freeTextContent?: string;
174
+ isFreeText?: boolean;
175
+ disableGenericPrompt?: boolean;
176
+ _id?: ObjectId;
177
+
178
+ flowName: string;
179
+ clientId: string;
180
+
181
+ systemInstructions: string;
182
+ initialSentence: string;
183
+ voice?: string;
184
+
185
+ insights: string[];
186
+ conversationSettings?: ConversationSettings;
187
+
188
+ interactions: Interaction[];
189
+
190
+ edges?: Edge[] | null;
191
+ metaKeys?: MetaKey[] | null;
192
+ userProperties?: UserProperty[] | null;
193
+ tools?: FlowTool[];
194
+ afterCallEvent?: string;
195
+
196
+ products?: string[];
197
+
198
+ // AI provider configuration
199
+ aiProvider?: any;
200
+
201
+ /** Internal tool toggles and per-parameter overrides, keyed by tool name. */
202
+ internalTools?: Record<string, InternalToolConfig>;
203
+
204
+ // Timestamps
205
+ createdAt?: Date;
206
+ updatedAt?: Date;
207
+ };
208
+
209
+ export type FlowUpdateParams = Partial<
210
+ Omit<Flow, "_id" | "clientId" | "createdAt">
211
+ >;
@@ -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
+ });