@talkpilot/core-db 1.3.63 → 1.3.64

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 (257) 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 +816 -815
  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/talkpilot/callTokenUsage/callTokenUsage.getters.d.ts +4 -0
  10. package/dist/talkpilot/callTokenUsage/callTokenUsage.getters.d.ts.map +1 -0
  11. package/dist/talkpilot/callTokenUsage/callTokenUsage.getters.js +30 -0
  12. package/dist/talkpilot/callTokenUsage/callTokenUsage.getters.js.map +1 -0
  13. package/dist/talkpilot/callTokenUsage/callTokenUsage.types.d.ts +28 -0
  14. package/dist/talkpilot/callTokenUsage/callTokenUsage.types.d.ts.map +1 -0
  15. package/dist/{reconcile/reconcile.types.js → talkpilot/callTokenUsage/callTokenUsage.types.js} +1 -1
  16. package/dist/talkpilot/callTokenUsage/callTokenUsage.types.js.map +1 -0
  17. package/dist/talkpilot/callTokenUsage/index.d.ts +3 -0
  18. package/dist/talkpilot/callTokenUsage/index.d.ts.map +1 -0
  19. package/dist/{reconcile → talkpilot/callTokenUsage}/index.js +1 -4
  20. package/dist/talkpilot/callTokenUsage/index.js.map +1 -0
  21. package/dist/talkpilot/index.d.ts +1 -0
  22. package/dist/talkpilot/index.d.ts.map +1 -1
  23. package/dist/talkpilot/index.js +1 -0
  24. package/dist/talkpilot/index.js.map +1 -1
  25. package/jest.config.js +20 -20
  26. package/package.json +46 -46
  27. package/src/__tests__/setup.ts +20 -20
  28. package/src/bulkWrite/__tests__/bulkWrite.spec.ts +65 -65
  29. package/src/bulkWrite/bulkWrite.ops.ts +45 -45
  30. package/src/bulkWrite/bulkWrite.types.ts +4 -4
  31. package/src/bulkWrite/index.ts +2 -2
  32. package/src/config.ts +9 -9
  33. package/src/configuration/index.ts +17 -17
  34. package/src/configuration/internalModels/index.ts +3 -3
  35. package/src/configuration/internalModels/internalModels.constants.ts +1 -1
  36. package/src/configuration/internalModels/internalModels.getters.ts +33 -33
  37. package/src/configuration/internalModels/internalModels.types.ts +12 -12
  38. package/src/configuration/models/__tests__/models.getters.spec.ts +67 -67
  39. package/src/configuration/models/index.ts +27 -27
  40. package/src/configuration/models/models.constants.ts +15 -20
  41. package/src/configuration/models/models.getters.ts +71 -71
  42. package/src/configuration/models/models.types.ts +80 -80
  43. package/src/configuration/mongodb-client.ts +62 -62
  44. package/src/configuration/prompts/index.ts +2 -2
  45. package/src/configuration/prompts/prompts.getters.ts +49 -49
  46. package/src/configuration/prompts/prompts.types.ts +11 -11
  47. package/src/connection.ts +81 -81
  48. package/src/index.ts +47 -47
  49. package/src/municipal/__tests__/validation.spec.ts +62 -62
  50. package/src/municipal/cities/cities.getters.ts +50 -50
  51. package/src/municipal/cities/cities.types.ts +11 -11
  52. package/src/municipal/cities/index.ts +2 -2
  53. package/src/municipal/departmentsSubjects/__tests__/departmentsSubjects.spec.ts +272 -272
  54. package/src/municipal/departmentsSubjects/departmentsSubjects.getters.ts +317 -317
  55. package/src/municipal/departmentsSubjects/departmentsSubjects.types.ts +73 -73
  56. package/src/municipal/departmentsSubjects/index.ts +9 -9
  57. package/src/municipal/index.ts +22 -22
  58. package/src/municipal/mongodb-client.ts +61 -61
  59. package/src/municipal/muniIssues/__tests__/muniIssues.setters.spec.ts +94 -94
  60. package/src/municipal/muniIssues/__tests__/muniIssues.setup.spec.ts +92 -92
  61. package/src/municipal/muniIssues/index.ts +17 -17
  62. package/src/municipal/muniIssues/muniIssues.constants.ts +18 -18
  63. package/src/municipal/muniIssues/muniIssues.getters.ts +24 -24
  64. package/src/municipal/muniIssues/muniIssues.schema.ts +66 -66
  65. package/src/municipal/muniIssues/muniIssues.setters.ts +24 -24
  66. package/src/municipal/muniIssues/muniIssues.setup.ts +65 -65
  67. package/src/municipal/muniIssues/muniIssues.types.ts +37 -37
  68. package/src/municipal/streets/__tests__/streets.spec.ts +253 -253
  69. package/src/municipal/streets/index.ts +2 -2
  70. package/src/municipal/streets/streets.getters.ts +140 -140
  71. package/src/municipal/streets/streets.types.ts +19 -19
  72. package/src/municipal/systemInstructions/__tests__/getters.spec.ts +113 -113
  73. package/src/municipal/systemInstructions/__tests__/setters.spec.ts +274 -274
  74. package/src/municipal/systemInstructions/index.ts +7 -7
  75. package/src/municipal/systemInstructions/instructions.getters.ts +57 -57
  76. package/src/municipal/systemInstructions/instructions.setters.ts +119 -119
  77. package/src/municipal/systemInstructions/instructions.types.ts +30 -30
  78. package/src/municipal/tickets/__tests__/tickets.getters.spec.ts +30 -30
  79. package/src/municipal/tickets/__tests__/tickets.statistics.spec.ts +99 -99
  80. package/src/municipal/tickets/index.ts +9 -9
  81. package/src/municipal/tickets/tickets.constants.ts +8 -8
  82. package/src/municipal/tickets/tickets.getters.ts +121 -121
  83. package/src/municipal/tickets/tickets.statistics.aggregation.ts +110 -110
  84. package/src/municipal/tickets/tickets.statistics.getters.ts +145 -145
  85. package/src/municipal/tickets/tickets.types.ts +54 -54
  86. package/src/municipal/utils/types.ts +11 -11
  87. package/src/talkpilot/__tests__/db.spec.ts +38 -38
  88. package/src/talkpilot/__tests__/mongodb-client.spec.ts +18 -18
  89. package/src/talkpilot/__tests__/validation.spec.ts +68 -68
  90. package/src/talkpilot/agents/__tests__/agents.getters.spec.ts +29 -29
  91. package/src/talkpilot/agents/agents.getters.ts +34 -34
  92. package/src/talkpilot/agents/agents.types.ts +14 -14
  93. package/src/talkpilot/agents/index.ts +2 -2
  94. package/src/talkpilot/backgroundToolResults/__tests__/backgroundToolResults.getters.spec.ts +147 -147
  95. package/src/talkpilot/backgroundToolResults/backgroundToolResults.getters.ts +65 -65
  96. package/src/talkpilot/backgroundToolResults/backgroundToolResults.types.ts +23 -23
  97. package/src/talkpilot/backgroundToolResults/index.ts +2 -2
  98. package/src/talkpilot/callTokenUsage/__tests__/callTokenUsage.getters.spec.ts +57 -0
  99. package/src/talkpilot/callTokenUsage/callTokenUsage.getters.ts +42 -0
  100. package/src/talkpilot/callTokenUsage/callTokenUsage.types.ts +28 -0
  101. package/src/talkpilot/callTokenUsage/index.ts +2 -0
  102. package/src/talkpilot/calls/__tests__/callStats.utils.spec.ts +128 -128
  103. package/src/talkpilot/calls/__tests__/calls.dashboard.spec.ts +229 -229
  104. package/src/talkpilot/calls/__tests__/calls.spec.ts +471 -471
  105. package/src/talkpilot/calls/__tests__/calls.statistics.spec.ts +483 -483
  106. package/src/talkpilot/calls/calls.constants.ts +49 -49
  107. package/src/talkpilot/calls/calls.getters.ts +277 -277
  108. package/src/talkpilot/calls/calls.statistics.getters.ts +668 -668
  109. package/src/talkpilot/calls/calls.statistics.types.ts +48 -48
  110. package/src/talkpilot/calls/calls.types.ts +149 -149
  111. package/src/talkpilot/calls/dashboard/calls.dashboard.ts +295 -295
  112. package/src/talkpilot/calls/dashboard/calls.dashboard.types.ts +57 -57
  113. package/src/talkpilot/calls/index.ts +6 -6
  114. package/src/talkpilot/clientAudioBuffers/__tests__/clientAudioBuffer.getters.spec.ts +160 -160
  115. package/src/talkpilot/clientAudioBuffers/clientAudioBuffer.getters.ts +117 -117
  116. package/src/talkpilot/clientAudioBuffers/clientsAudioBuffers.types.ts +25 -25
  117. package/src/talkpilot/clientAudioBuffers/index.ts +2 -2
  118. package/src/talkpilot/clients/__tests__/clients.quota.spec.ts +123 -123
  119. package/src/talkpilot/clients/clients.getters.ts +19 -19
  120. package/src/talkpilot/clients/clients.quota.getters.ts +119 -119
  121. package/src/talkpilot/clients/clients.quota.types.ts +27 -27
  122. package/src/talkpilot/clients/clients.types.ts +18 -18
  123. package/src/talkpilot/clients/index.ts +4 -4
  124. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.getters.spec.ts +423 -423
  125. package/src/talkpilot/clientsConfig/__tests__/clientsConfig.spec.ts +212 -212
  126. package/src/talkpilot/clientsConfig/clientsConfig.constants.ts +2 -2
  127. package/src/talkpilot/clientsConfig/clientsConfig.getters.ts +247 -247
  128. package/src/talkpilot/clientsConfig/clientsConfig.types.ts +137 -137
  129. package/src/talkpilot/clientsConfig/index.ts +3 -3
  130. package/src/talkpilot/contextNotes/__tests__/contextNotes.getters.spec.ts +217 -217
  131. package/src/talkpilot/contextNotes/contextNotes.getters.ts +85 -85
  132. package/src/talkpilot/contextNotes/contextNotes.types.ts +20 -20
  133. package/src/talkpilot/contextNotes/index.ts +2 -2
  134. package/src/talkpilot/flows/__tests__/flows.schema.spec.ts +124 -124
  135. package/src/talkpilot/flows/flows.getter.ts +34 -34
  136. package/src/talkpilot/flows/flows.schema.ts +180 -180
  137. package/src/talkpilot/flows/flows.types.ts +211 -211
  138. package/src/talkpilot/flows/index.ts +7 -7
  139. package/src/talkpilot/groups/__tests__/groups.spec.ts +90 -90
  140. package/src/talkpilot/groups/__tests__/phone.utils.spec.ts +32 -32
  141. package/src/talkpilot/groups/groups.getters.ts +30 -30
  142. package/src/talkpilot/groups/groups.types.ts +29 -29
  143. package/src/talkpilot/groups/index.ts +3 -3
  144. package/src/talkpilot/groups/phone.utils.ts +46 -46
  145. package/src/talkpilot/index.ts +32 -31
  146. package/src/talkpilot/leads/index.ts +2 -2
  147. package/src/talkpilot/leads/leads.getter.ts +6 -6
  148. package/src/talkpilot/leads/leads.schema.ts +33 -33
  149. package/src/talkpilot/leads/leads.types.ts +20 -20
  150. package/src/talkpilot/mongodb-client.ts +78 -78
  151. package/src/talkpilot/phone_numbers/__tests__/phone_numbers.spec.ts +530 -530
  152. package/src/talkpilot/phone_numbers/index.ts +2 -2
  153. package/src/talkpilot/phone_numbers/phone_numbers.getter.ts +240 -240
  154. package/src/talkpilot/phone_numbers/phone_numbers.schema.ts +17 -17
  155. package/src/talkpilot/phone_numbers/phone_numbers.types.ts +30 -30
  156. package/src/talkpilot/phone_numbers/phone_numbers.utils.ts +9 -9
  157. package/src/talkpilot/plans/__tests__/plans.spec.ts +70 -70
  158. package/src/talkpilot/plans/index.ts +2 -2
  159. package/src/talkpilot/plans/plans.getters.ts +132 -132
  160. package/src/talkpilot/plans/plans.types.ts +89 -89
  161. package/src/talkpilot/products/__tests__/products.getters.spec.ts +44 -44
  162. package/src/talkpilot/products/index.ts +2 -2
  163. package/src/talkpilot/products/products.getters.ts +12 -12
  164. package/src/talkpilot/products/products.types.ts +9 -9
  165. package/src/talkpilot/results/index.ts +7 -7
  166. package/src/talkpilot/results/results.getter.ts +39 -39
  167. package/src/talkpilot/results/results.schema.ts +25 -25
  168. package/src/talkpilot/results/results.types.ts +34 -34
  169. package/src/talkpilot/retry_analyze/__tests__/retryAnalyze.getters.spec.ts +156 -156
  170. package/src/talkpilot/retry_analyze/index.ts +2 -2
  171. package/src/talkpilot/retry_analyze/retryAnalyze.getters.ts +84 -84
  172. package/src/talkpilot/retry_analyze/retryAnalyze.types.ts +13 -13
  173. package/src/talkpilot/sessions/__tests__/sessions.spec.ts +147 -147
  174. package/src/talkpilot/sessions/index.ts +2 -2
  175. package/src/talkpilot/sessions/sessions.getter.ts +92 -92
  176. package/src/talkpilot/sessions/sessions.schema.ts +34 -34
  177. package/src/talkpilot/sessions/sessions.types.ts +30 -30
  178. package/src/talkpilot/subscriptions/__tests__/subscriptions.getters.utils.spec.ts +45 -45
  179. package/src/talkpilot/subscriptions/index.ts +3 -3
  180. package/src/talkpilot/subscriptions/subscriptions.getters.ts +146 -146
  181. package/src/talkpilot/subscriptions/subscriptions.getters.utils.ts +33 -33
  182. package/src/talkpilot/subscriptions/subscriptions.types.ts +66 -66
  183. package/src/talkpilot/utils/__tests__/query.utils.spec.ts +49 -49
  184. package/src/talkpilot/utils/query.utils.ts +21 -21
  185. package/src/test-utils/db-utils.ts +33 -33
  186. package/src/test-utils/factories/index.ts +18 -18
  187. package/src/test-utils/factories/municipal/cities.ts +16 -16
  188. package/src/test-utils/factories/municipal/departmentsSubjects.ts +37 -37
  189. package/src/test-utils/factories/municipal/muniIssues.ts +32 -32
  190. package/src/test-utils/factories/municipal/streets.ts +22 -22
  191. package/src/test-utils/factories/municipal/tickets.ts +39 -39
  192. package/src/test-utils/factories/talkpilot/agents.ts +19 -19
  193. package/src/test-utils/factories/talkpilot/calls.ts +37 -37
  194. package/src/test-utils/factories/talkpilot/clientAudioBuffers.ts +20 -20
  195. package/src/test-utils/factories/talkpilot/clientsConfig.ts +18 -18
  196. package/src/test-utils/factories/talkpilot/contextNotes.ts +40 -40
  197. package/src/test-utils/factories/talkpilot/flows.ts +33 -33
  198. package/src/test-utils/factories/talkpilot/groups.ts +33 -33
  199. package/src/test-utils/factories/talkpilot/phone_numbers.ts +22 -22
  200. package/src/test-utils/factories/talkpilot/sessions.ts +35 -35
  201. package/src/test-utils/factories/websitalk/knowledgeDocuments.ts +29 -29
  202. package/src/test-utils/factories/websitalk/scanResources.ts +26 -26
  203. package/src/test-utils/factories/websitalk/scans.ts +30 -30
  204. package/src/test-utils/factories/websitalk/websiteUrls.ts +17 -17
  205. package/src/utils/date.utils.ts +126 -126
  206. package/src/utils/shared.types.ts +4 -4
  207. package/src/utils/validation.ts +23 -23
  208. package/src/websitalk/index.ts +18 -18
  209. package/src/websitalk/knowledgeDocuments/__tests__/knowledgeDocuments.spec.ts +238 -238
  210. package/src/websitalk/knowledgeDocuments/index.ts +3 -3
  211. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.constants.ts +26 -26
  212. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.getters.ts +95 -95
  213. package/src/websitalk/knowledgeDocuments/knowledgeDocuments.types.ts +75 -75
  214. package/src/websitalk/mongodb-client.ts +61 -61
  215. package/src/websitalk/scanResources/__tests__/scanResources.spec.ts +267 -267
  216. package/src/websitalk/scanResources/index.ts +4 -4
  217. package/src/websitalk/scanResources/scanResources.constants.ts +60 -60
  218. package/src/websitalk/scanResources/scanResources.getters.ts +128 -128
  219. package/src/websitalk/scanResources/scanResources.types.ts +105 -105
  220. package/src/websitalk/scanResources/scanResources.utils.ts +31 -31
  221. package/src/websitalk/scans/__tests__/scans.spec.ts +362 -362
  222. package/src/websitalk/scans/index.ts +4 -4
  223. package/src/websitalk/scans/scans.constants.ts +18 -18
  224. package/src/websitalk/scans/scans.getters.ts +172 -172
  225. package/src/websitalk/scans/scans.types.ts +58 -58
  226. package/src/websitalk/scans/scans.utils.ts +5 -5
  227. package/src/websitalk/websiteUrls/__tests__/websiteUrls.spec.ts +77 -77
  228. package/src/websitalk/websiteUrls/index.ts +2 -2
  229. package/src/websitalk/websiteUrls/websiteUrls.getters.ts +65 -65
  230. package/src/websitalk/websiteUrls/websiteUrls.types.ts +13 -13
  231. package/tsconfig.json +23 -23
  232. package/dist/municipal/departmentsSubjects/departmentsSubjects.setters.d.ts +0 -10
  233. package/dist/municipal/departmentsSubjects/departmentsSubjects.setters.d.ts.map +0 -1
  234. package/dist/municipal/departmentsSubjects/departmentsSubjects.setters.js +0 -15
  235. package/dist/municipal/departmentsSubjects/departmentsSubjects.setters.js.map +0 -1
  236. package/dist/municipal/streets/streets.setters.d.ts +0 -10
  237. package/dist/municipal/streets/streets.setters.d.ts.map +0 -1
  238. package/dist/municipal/streets/streets.setters.js +0 -15
  239. package/dist/municipal/streets/streets.setters.js.map +0 -1
  240. package/dist/reconcile/index.d.ts +0 -5
  241. package/dist/reconcile/index.d.ts.map +0 -1
  242. package/dist/reconcile/index.js.map +0 -1
  243. package/dist/reconcile/reconcile.diff.d.ts +0 -4
  244. package/dist/reconcile/reconcile.diff.d.ts.map +0 -1
  245. package/dist/reconcile/reconcile.diff.js +0 -36
  246. package/dist/reconcile/reconcile.diff.js.map +0 -1
  247. package/dist/reconcile/reconcile.execute.d.ts +0 -7
  248. package/dist/reconcile/reconcile.execute.d.ts.map +0 -1
  249. package/dist/reconcile/reconcile.execute.js +0 -20
  250. package/dist/reconcile/reconcile.execute.js.map +0 -1
  251. package/dist/reconcile/reconcile.ops.d.ts +0 -12
  252. package/dist/reconcile/reconcile.ops.d.ts.map +0 -1
  253. package/dist/reconcile/reconcile.ops.js +0 -24
  254. package/dist/reconcile/reconcile.ops.js.map +0 -1
  255. package/dist/reconcile/reconcile.types.d.ts +0 -32
  256. package/dist/reconcile/reconcile.types.d.ts.map +0 -1
  257. package/dist/reconcile/reconcile.types.js.map +0 -1
@@ -1,17 +1,17 @@
1
- import { Db, ObjectId as MongoObjectId } from "mongodb";
2
-
3
- export * from "./prompts";
4
- export * from "./models";
5
- export * from "./internalModels";
6
- export { configurationMongodbClient } from "./mongodb-client";
7
-
8
- let db: Db;
9
- export const setDb = (d: Db) => {
10
- db = d;
11
- };
12
-
13
- export const getDb = (): Db => {
14
- if (!db) throw new Error("Configuration DB not initialised");
15
- return db;
16
- };
17
- export const ObjectId = MongoObjectId;
1
+ import { Db, ObjectId as MongoObjectId } from "mongodb";
2
+
3
+ export * from "./prompts";
4
+ export * from "./models";
5
+ export * from "./internalModels";
6
+ export { configurationMongodbClient } from "./mongodb-client";
7
+
8
+ let db: Db;
9
+ export const setDb = (d: Db) => {
10
+ db = d;
11
+ };
12
+
13
+ export const getDb = (): Db => {
14
+ if (!db) throw new Error("Configuration DB not initialised");
15
+ return db;
16
+ };
17
+ export const ObjectId = MongoObjectId;
@@ -1,3 +1,3 @@
1
- export { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
2
- export * from "./internalModels.getters";
3
- export type { InternalModel } from "./internalModels.types";
1
+ export { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
2
+ export * from "./internalModels.getters";
3
+ export type { InternalModel } from "./internalModels.types";
@@ -1 +1 @@
1
- export const INTERNAL_MODELS_COLLECTION = "internal-models";
1
+ export const INTERNAL_MODELS_COLLECTION = "internal-models";
@@ -1,33 +1,33 @@
1
- import { getDb } from "../index";
2
- import { Collection, Filter } from "mongodb";
3
- import { InternalModel } from "./internalModels.types";
4
- import { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
5
-
6
- export const getInternalModelsCollection = (): Collection<InternalModel> => {
7
- return getDb().collection<InternalModel>(INTERNAL_MODELS_COLLECTION);
8
- };
9
-
10
- /**
11
- * Get an internal model config by its unique name
12
- */
13
- export const getInternalModelByName = async (
14
- name: string
15
- ): Promise<InternalModel | null> => {
16
- return await getInternalModelsCollection().findOne({ name });
17
- };
18
-
19
- /**
20
- * Find internal models by filter.
21
- */
22
- export const findInternalModels = async (
23
- filter: Filter<InternalModel> = {}
24
- ): Promise<InternalModel[]> => {
25
- return await getInternalModelsCollection().find(filter).toArray();
26
- };
27
-
28
- /**
29
- * Get all internal models.
30
- */
31
- export const getAllInternalModels = async (): Promise<InternalModel[]> => {
32
- return await findInternalModels();
33
- };
1
+ import { getDb } from "../index";
2
+ import { Collection, Filter } from "mongodb";
3
+ import { InternalModel } from "./internalModels.types";
4
+ import { INTERNAL_MODELS_COLLECTION } from "./internalModels.constants";
5
+
6
+ export const getInternalModelsCollection = (): Collection<InternalModel> => {
7
+ return getDb().collection<InternalModel>(INTERNAL_MODELS_COLLECTION);
8
+ };
9
+
10
+ /**
11
+ * Get an internal model config by its unique name
12
+ */
13
+ export const getInternalModelByName = async (
14
+ name: string
15
+ ): Promise<InternalModel | null> => {
16
+ return await getInternalModelsCollection().findOne({ name });
17
+ };
18
+
19
+ /**
20
+ * Find internal models by filter.
21
+ */
22
+ export const findInternalModels = async (
23
+ filter: Filter<InternalModel> = {}
24
+ ): Promise<InternalModel[]> => {
25
+ return await getInternalModelsCollection().find(filter).toArray();
26
+ };
27
+
28
+ /**
29
+ * Get all internal models.
30
+ */
31
+ export const getAllInternalModels = async (): Promise<InternalModel[]> => {
32
+ return await findInternalModels();
33
+ };
@@ -1,12 +1,12 @@
1
- import { ObjectId } from "mongodb";
2
-
3
- export type InternalModel = {
4
- _id: ObjectId;
5
- /** Has to be unique between other names in collection */
6
- name: string;
7
- provider: string;
8
- model: string;
9
- config?: Record<string, unknown>;
10
- createdAt: Date;
11
- updatedAt: Date;
12
- };
1
+ import { ObjectId } from "mongodb";
2
+
3
+ export type InternalModel = {
4
+ _id: ObjectId;
5
+ /** Has to be unique between other names in collection */
6
+ name: string;
7
+ provider: string;
8
+ model: string;
9
+ config?: Record<string, unknown>;
10
+ createdAt: Date;
11
+ updatedAt: Date;
12
+ };
@@ -1,67 +1,67 @@
1
- import { ObjectId } from "mongodb";
2
- import { MODELS_COLLECTION } from "../models.constants";
3
- import {
4
- getModelsCollection,
5
- getModelContextWindow,
6
- } from "../models.getters";
7
- import type { RealtimeModelDoc } from "../models.types";
8
-
9
- function realtimeModel(
10
- overrides: Partial<RealtimeModelDoc> & Pick<RealtimeModelDoc, "modelId">,
11
- ): RealtimeModelDoc {
12
- const now = new Date();
13
- return {
14
- _id: new ObjectId(),
15
- name: overrides.modelId,
16
- type: "realtime",
17
- provider: "openai",
18
- available: true,
19
- createdAt: now,
20
- updatedAt: now,
21
- ...overrides,
22
- };
23
- }
24
-
25
- describe("getModelContextWindow", () => {
26
- it("returns configDefaults.contextWindow for the model", async () => {
27
- await getModelsCollection().insertOne(
28
- realtimeModel({
29
- modelId: "gpt-realtime",
30
- configDefaults: { contextWindow: 32_000 },
31
- }),
32
- );
33
-
34
- await expect(getModelContextWindow("gpt-realtime")).resolves.toBe(32_000);
35
- });
36
-
37
- it("returns null when the model is missing", async () => {
38
- await expect(getModelContextWindow("missing-model")).resolves.toBeNull();
39
- });
40
-
41
- it("returns null when contextWindow is missing or not a positive number", async () => {
42
- await getModelsCollection().insertMany([
43
- realtimeModel({
44
- modelId: "no-window",
45
- configDefaults: {},
46
- }),
47
- realtimeModel({
48
- modelId: "zero-window",
49
- configDefaults: { contextWindow: 0 },
50
- }),
51
- realtimeModel({
52
- modelId: "string-window",
53
- configDefaults: { contextWindow: "64000" },
54
- }),
55
- ]);
56
-
57
- await expect(getModelContextWindow("no-window")).resolves.toBeNull();
58
- await expect(getModelContextWindow("zero-window")).resolves.toBeNull();
59
- await expect(getModelContextWindow("string-window")).resolves.toBeNull();
60
- });
61
- });
62
-
63
- describe("models collection", () => {
64
- it(`uses the "${MODELS_COLLECTION}" collection`, () => {
65
- expect(getModelsCollection().collectionName).toBe(MODELS_COLLECTION);
66
- });
67
- });
1
+ import { ObjectId } from "mongodb";
2
+ import { MODELS_COLLECTION } from "../models.constants";
3
+ import {
4
+ getModelsCollection,
5
+ getModelContextWindow,
6
+ } from "../models.getters";
7
+ import type { RealtimeModelDoc } from "../models.types";
8
+
9
+ function realtimeModel(
10
+ overrides: Partial<RealtimeModelDoc> & Pick<RealtimeModelDoc, "modelId">,
11
+ ): RealtimeModelDoc {
12
+ const now = new Date();
13
+ return {
14
+ _id: new ObjectId(),
15
+ name: overrides.modelId,
16
+ type: "realtime",
17
+ provider: "openai",
18
+ available: true,
19
+ createdAt: now,
20
+ updatedAt: now,
21
+ ...overrides,
22
+ };
23
+ }
24
+
25
+ describe("getModelContextWindow", () => {
26
+ it("returns configDefaults.contextWindow for the model", async () => {
27
+ await getModelsCollection().insertOne(
28
+ realtimeModel({
29
+ modelId: "gpt-realtime",
30
+ configDefaults: { contextWindow: 32_000 },
31
+ }),
32
+ );
33
+
34
+ await expect(getModelContextWindow("gpt-realtime")).resolves.toBe(32_000);
35
+ });
36
+
37
+ it("returns null when the model is missing", async () => {
38
+ await expect(getModelContextWindow("missing-model")).resolves.toBeNull();
39
+ });
40
+
41
+ it("returns null when contextWindow is missing or not a positive number", async () => {
42
+ await getModelsCollection().insertMany([
43
+ realtimeModel({
44
+ modelId: "no-window",
45
+ configDefaults: {},
46
+ }),
47
+ realtimeModel({
48
+ modelId: "zero-window",
49
+ configDefaults: { contextWindow: 0 },
50
+ }),
51
+ realtimeModel({
52
+ modelId: "string-window",
53
+ configDefaults: { contextWindow: "64000" },
54
+ }),
55
+ ]);
56
+
57
+ await expect(getModelContextWindow("no-window")).resolves.toBeNull();
58
+ await expect(getModelContextWindow("zero-window")).resolves.toBeNull();
59
+ await expect(getModelContextWindow("string-window")).resolves.toBeNull();
60
+ });
61
+ });
62
+
63
+ describe("models collection", () => {
64
+ it(`uses the "${MODELS_COLLECTION}" collection`, () => {
65
+ expect(getModelsCollection().collectionName).toBe(MODELS_COLLECTION);
66
+ });
67
+ });
@@ -1,27 +1,27 @@
1
- export {
2
- MODELS_COLLECTION,
3
- MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
4
- MODEL_TYPES,
5
- REALTIME_MODEL_PROVIDERS,
6
- STT_MODEL_PROVIDERS,
7
- } from "./models.constants";
8
- export {
9
- getModelsCollection,
10
- findModels,
11
- getModelByModelId,
12
- getModelContextWindow,
13
- getModelsByProvider,
14
- getModelsByType,
15
- getAvailableModelsByType,
16
- } from "./models.getters";
17
- export type {
18
- ModelType,
19
- RealtimeModelProvider,
20
- SttModelProvider,
21
- SemanticVad,
22
- ServerVad,
23
- TurnDetection,
24
- RealtimeModelDoc,
25
- SttModelDoc,
26
- ModelDoc,
27
- } from "./models.types";
1
+ export {
2
+ MODELS_COLLECTION,
3
+ MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
4
+ MODEL_TYPES,
5
+ REALTIME_MODEL_PROVIDERS,
6
+ STT_MODEL_PROVIDERS,
7
+ } from "./models.constants";
8
+ export {
9
+ getModelsCollection,
10
+ findModels,
11
+ getModelByModelId,
12
+ getModelContextWindow,
13
+ getModelsByProvider,
14
+ getModelsByType,
15
+ getAvailableModelsByType,
16
+ } from "./models.getters";
17
+ export type {
18
+ ModelType,
19
+ RealtimeModelProvider,
20
+ SttModelProvider,
21
+ SemanticVad,
22
+ ServerVad,
23
+ TurnDetection,
24
+ RealtimeModelDoc,
25
+ SttModelDoc,
26
+ ModelDoc,
27
+ } from "./models.types";
@@ -1,20 +1,15 @@
1
- export const MODELS_COLLECTION = "models";
2
-
3
- export const MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW = "contextWindow";
4
-
5
- export const MODEL_TYPES = ["realtime", "stt"] as const;
6
-
7
- export const REALTIME_MODEL_PROVIDERS = [
8
- "openai",
9
- "gemini",
10
- "xai",
11
- "elevenlabs",
12
- ] as const;
13
- export const STT_MODEL_PROVIDERS = [
14
- "openai-stt",
15
- "google-stt",
16
- "deepgram-stt",
17
- "deepgram-flux",
18
- "elevenlabs-scribe",
19
- "gladia-stt",
20
- ] as const;
1
+ export const MODELS_COLLECTION = "models";
2
+
3
+ export const MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW = "contextWindow";
4
+
5
+ export const MODEL_TYPES = ["realtime", "stt"] as const;
6
+
7
+ export const REALTIME_MODEL_PROVIDERS = ["openai", "gemini", "xai"] as const;
8
+ export const STT_MODEL_PROVIDERS = [
9
+ "openai-stt",
10
+ "google-stt",
11
+ "deepgram-stt",
12
+ "deepgram-flux",
13
+ "elevenlabs-scribe",
14
+ "gladia-stt",
15
+ ] as const;
@@ -1,71 +1,71 @@
1
- import { Collection, Filter } from "mongodb";
2
-
3
- import { getDb } from "../index";
4
- import {
5
- MODELS_COLLECTION,
6
- MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
7
- } from "./models.constants";
8
- import { ModelDoc, ModelType } from "./models.types";
9
-
10
- /** Raw typed handle to the `models` collection. */
11
- export const getModelsCollection = (): Collection<ModelDoc> => {
12
- return getDb().collection<ModelDoc>(MODELS_COLLECTION);
13
- };
14
-
15
- /** Find models by an arbitrary filter. */
16
- export const findModels = async (
17
- filter: Filter<ModelDoc> = {},
18
- ): Promise<ModelDoc[]> => {
19
- return await getModelsCollection().find(filter).toArray();
20
- };
21
-
22
- /**
23
- * Get a single model by its `modelId`, optionally scoped to a `type`.
24
- * @param modelId e.g. "deepgram-stt-phonecall"
25
- * @param type optional narrowing filter, since `modelId` isn't guaranteed unique across types
26
- */
27
- export const getModelByModelId = async (
28
- modelId: string,
29
- type?: ModelType,
30
- ): Promise<ModelDoc | null> => {
31
- const filter = (type ? { modelId, type } : { modelId }) as Filter<ModelDoc>;
32
- return await getModelsCollection().findOne(filter);
33
- };
34
-
35
- /**
36
- * Token context window for a model (`configDefaults.contextWindow`).
37
- * `null` when the model is missing or the value is not a positive number.
38
- */
39
- export const getModelContextWindow = async (
40
- modelId: string,
41
- ): Promise<number | null> => {
42
- const doc = await getModelByModelId(modelId);
43
- const value = doc?.configDefaults?.[MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW];
44
- if (typeof value !== "number" || !Number.isFinite(value) || value <= 0) {
45
- return null;
46
- }
47
- return Math.floor(value);
48
- };
49
-
50
- /**
51
- * Get all models for a given `provider`, optionally scoped to a `type`.
52
- */
53
- export const getModelsByProvider = async (
54
- provider: string,
55
- type?: ModelType,
56
- ): Promise<ModelDoc[]> => {
57
- const filter = (type ? { provider, type } : { provider }) as Filter<ModelDoc>;
58
- return await findModels(filter);
59
- };
60
-
61
- /** Get all models of a given `type`. */
62
- export const getModelsByType = async (type: ModelType): Promise<ModelDoc[]> => {
63
- return await findModels({ type } as Filter<ModelDoc>);
64
- };
65
-
66
- /** Get all models of a given `type` where `available` is true. */
67
- export const getAvailableModelsByType = async (
68
- type: ModelType,
69
- ): Promise<ModelDoc[]> => {
70
- return await findModels({ type, available: true } as Filter<ModelDoc>);
71
- };
1
+ import { Collection, Filter } from "mongodb";
2
+
3
+ import { getDb } from "../index";
4
+ import {
5
+ MODELS_COLLECTION,
6
+ MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW,
7
+ } from "./models.constants";
8
+ import { ModelDoc, ModelType } from "./models.types";
9
+
10
+ /** Raw typed handle to the `models` collection. */
11
+ export const getModelsCollection = (): Collection<ModelDoc> => {
12
+ return getDb().collection<ModelDoc>(MODELS_COLLECTION);
13
+ };
14
+
15
+ /** Find models by an arbitrary filter. */
16
+ export const findModels = async (
17
+ filter: Filter<ModelDoc> = {},
18
+ ): Promise<ModelDoc[]> => {
19
+ return await getModelsCollection().find(filter).toArray();
20
+ };
21
+
22
+ /**
23
+ * Get a single model by its `modelId`, optionally scoped to a `type`.
24
+ * @param modelId e.g. "deepgram-stt-phonecall"
25
+ * @param type optional narrowing filter, since `modelId` isn't guaranteed unique across types
26
+ */
27
+ export const getModelByModelId = async (
28
+ modelId: string,
29
+ type?: ModelType,
30
+ ): Promise<ModelDoc | null> => {
31
+ const filter = (type ? { modelId, type } : { modelId }) as Filter<ModelDoc>;
32
+ return await getModelsCollection().findOne(filter);
33
+ };
34
+
35
+ /**
36
+ * Token context window for a model (`configDefaults.contextWindow`).
37
+ * `null` when the model is missing or the value is not a positive number.
38
+ */
39
+ export const getModelContextWindow = async (
40
+ modelId: string,
41
+ ): Promise<number | null> => {
42
+ const doc = await getModelByModelId(modelId);
43
+ const value = doc?.configDefaults?.[MODEL_CONFIG_DEFAULTS_CONTEXT_WINDOW];
44
+ if (typeof value !== "number" || !Number.isFinite(value) || value <= 0) {
45
+ return null;
46
+ }
47
+ return Math.floor(value);
48
+ };
49
+
50
+ /**
51
+ * Get all models for a given `provider`, optionally scoped to a `type`.
52
+ */
53
+ export const getModelsByProvider = async (
54
+ provider: string,
55
+ type?: ModelType,
56
+ ): Promise<ModelDoc[]> => {
57
+ const filter = (type ? { provider, type } : { provider }) as Filter<ModelDoc>;
58
+ return await findModels(filter);
59
+ };
60
+
61
+ /** Get all models of a given `type`. */
62
+ export const getModelsByType = async (type: ModelType): Promise<ModelDoc[]> => {
63
+ return await findModels({ type } as Filter<ModelDoc>);
64
+ };
65
+
66
+ /** Get all models of a given `type` where `available` is true. */
67
+ export const getAvailableModelsByType = async (
68
+ type: ModelType,
69
+ ): Promise<ModelDoc[]> => {
70
+ return await findModels({ type, available: true } as Filter<ModelDoc>);
71
+ };
@@ -1,80 +1,80 @@
1
- import { ObjectId } from "mongodb";
2
-
3
- import {
4
- MODEL_TYPES,
5
- REALTIME_MODEL_PROVIDERS,
6
- STT_MODEL_PROVIDERS,
7
- } from "./models.constants";
8
-
9
- export type ModelType = (typeof MODEL_TYPES)[number];
10
- export type RealtimeModelProvider = (typeof REALTIME_MODEL_PROVIDERS)[number];
11
- export type SttModelProvider = (typeof STT_MODEL_PROVIDERS)[number];
12
-
13
- export type SemanticVad = {
14
- type: "semantic_vad";
15
- eagerness?: "low" | "medium" | "high" | "auto";
16
- create_response?: boolean;
17
- interrupt_response?: boolean;
18
- };
19
-
20
- export type ServerVad = {
21
- type: "server_vad";
22
- threshold: number;
23
- prefix_padding_ms: number;
24
- silence_duration_ms: number;
25
- create_response?: boolean;
26
- interrupt_response?: boolean;
27
- };
28
-
29
- export type TurnDetection = SemanticVad | ServerVad;
30
-
31
- type BaseModelDoc = {
32
- _id: ObjectId;
33
- /** Public identifier used by the provider, not to be confused with mongo id */
34
- modelId: string;
35
- name: string;
36
- description?: string;
37
- available: boolean;
38
- configDefaults?: Record<string, unknown>;
39
- createdAt: Date;
40
- updatedAt: Date;
41
- };
42
-
43
- /** Realtime speech-to-speech model (OpenAI/Gemini). `features.vad` is turn-detection config. */
44
- export type RealtimeModelDoc = BaseModelDoc & {
45
- type: "realtime";
46
- provider: RealtimeModelProvider;
47
- features?: {
48
- supportsAudio?: boolean;
49
- supportsText?: boolean;
50
- vad?: TurnDetection;
51
- };
52
- };
53
-
54
- /** STT engine/preset (openai-stt, google-stt, deepgram-stt/-flux, elevenlabs-scribe, gladia-stt). */
55
- export type SttModelDoc = BaseModelDoc & {
56
- type: "stt";
57
- provider: SttModelProvider;
58
- features?: {
59
- supportsAudio?: boolean;
60
- supportsText?: boolean;
61
- };
62
- };
63
-
64
- /**
65
- * A document in the `models` collection (configuration db). Discriminated by `type`.
66
- *
67
- * Common fields (all variants):
68
- * - `_id` — Mongo-managed ObjectId
69
- * - `modelId` — model's public identifier
70
- * - `name` — display name
71
- * - `description?` — display description
72
- * - `available` — whether the model should be offered/selectable right now
73
- * - `configDefaults?` — free-form provider-specific config, e.g. the literal vendor
74
- * model string, VAD tuning, language, barge-in timings, `contextWindow` (token
75
- * budget) — shape varies per `provider`
76
- * - `createdAt` / `updatedAt`
77
- *
78
- * Type-specific fields: see {@link RealtimeModelDoc}, {@link SttModelDoc}.
79
- */
80
- export type ModelDoc = RealtimeModelDoc | SttModelDoc;
1
+ import { ObjectId } from "mongodb";
2
+
3
+ import {
4
+ MODEL_TYPES,
5
+ REALTIME_MODEL_PROVIDERS,
6
+ STT_MODEL_PROVIDERS,
7
+ } from "./models.constants";
8
+
9
+ export type ModelType = (typeof MODEL_TYPES)[number];
10
+ export type RealtimeModelProvider = (typeof REALTIME_MODEL_PROVIDERS)[number];
11
+ export type SttModelProvider = (typeof STT_MODEL_PROVIDERS)[number];
12
+
13
+ export type SemanticVad = {
14
+ type: "semantic_vad";
15
+ eagerness?: "low" | "medium" | "high" | "auto";
16
+ create_response?: boolean;
17
+ interrupt_response?: boolean;
18
+ };
19
+
20
+ export type ServerVad = {
21
+ type: "server_vad";
22
+ threshold: number;
23
+ prefix_padding_ms: number;
24
+ silence_duration_ms: number;
25
+ create_response?: boolean;
26
+ interrupt_response?: boolean;
27
+ };
28
+
29
+ export type TurnDetection = SemanticVad | ServerVad;
30
+
31
+ type BaseModelDoc = {
32
+ _id: ObjectId;
33
+ /** Public identifier used by the provider, not to be confused with mongo id */
34
+ modelId: string;
35
+ name: string;
36
+ description?: string;
37
+ available: boolean;
38
+ configDefaults?: Record<string, unknown>;
39
+ createdAt: Date;
40
+ updatedAt: Date;
41
+ };
42
+
43
+ /** Realtime speech-to-speech model (OpenAI/Gemini). `features.vad` is turn-detection config. */
44
+ export type RealtimeModelDoc = BaseModelDoc & {
45
+ type: "realtime";
46
+ provider: RealtimeModelProvider;
47
+ features?: {
48
+ supportsAudio?: boolean;
49
+ supportsText?: boolean;
50
+ vad?: TurnDetection;
51
+ };
52
+ };
53
+
54
+ /** STT engine/preset (openai-stt, google-stt, deepgram-stt/-flux, elevenlabs-scribe, gladia-stt). */
55
+ export type SttModelDoc = BaseModelDoc & {
56
+ type: "stt";
57
+ provider: SttModelProvider;
58
+ features?: {
59
+ supportsAudio?: boolean;
60
+ supportsText?: boolean;
61
+ };
62
+ };
63
+
64
+ /**
65
+ * A document in the `models` collection (configuration db). Discriminated by `type`.
66
+ *
67
+ * Common fields (all variants):
68
+ * - `_id` — Mongo-managed ObjectId
69
+ * - `modelId` — model's public identifier
70
+ * - `name` — display name
71
+ * - `description?` — display description
72
+ * - `available` — whether the model should be offered/selectable right now
73
+ * - `configDefaults?` — free-form provider-specific config, e.g. the literal vendor
74
+ * model string, VAD tuning, language, barge-in timings, `contextWindow` (token
75
+ * budget) — shape varies per `provider`
76
+ * - `createdAt` / `updatedAt`
77
+ *
78
+ * Type-specific fields: see {@link RealtimeModelDoc}, {@link SttModelDoc}.
79
+ */
80
+ export type ModelDoc = RealtimeModelDoc | SttModelDoc;