@egain/egain-mcp-server 1.0.26 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (574) hide show
  1. package/README.md +20 -43
  2. package/bin/mcp-server.js +39534 -29516
  3. package/bin/mcp-server.js.map +298 -185
  4. package/esm/src/cloudflare-worker/cloudflare-worker.d.ts.map +1 -1
  5. package/esm/src/cloudflare-worker/cloudflare-worker.js +20 -9
  6. package/esm/src/cloudflare-worker/cloudflare-worker.js.map +1 -1
  7. package/esm/src/funcs/aiSearch.d.ts +63 -0
  8. package/esm/src/funcs/aiSearch.d.ts.map +1 -0
  9. package/esm/src/funcs/aiSearch.js +151 -0
  10. package/esm/src/funcs/aiSearch.js.map +1 -0
  11. package/esm/src/funcs/getAnnouncementArticles.d.ts +61 -0
  12. package/esm/src/funcs/getAnnouncementArticles.d.ts.map +1 -0
  13. package/esm/src/funcs/getAnnouncementArticles.js +152 -0
  14. package/esm/src/funcs/getAnnouncementArticles.js.map +1 -0
  15. package/esm/src/funcs/getAnnouncements.d.ts +39 -1
  16. package/esm/src/funcs/getAnnouncements.d.ts.map +1 -1
  17. package/esm/src/funcs/getAnnouncements.js +39 -1
  18. package/esm/src/funcs/getAnnouncements.js.map +1 -1
  19. package/esm/src/funcs/getArticle.d.ts +42 -0
  20. package/esm/src/funcs/getArticle.d.ts.map +1 -1
  21. package/esm/src/funcs/getArticle.js +42 -0
  22. package/esm/src/funcs/getArticle.js.map +1 -1
  23. package/esm/src/funcs/getArticleById.d.ts +70 -0
  24. package/esm/src/funcs/getArticleById.d.ts.map +1 -0
  25. package/esm/src/funcs/getArticleById.js +163 -0
  26. package/esm/src/funcs/getArticleById.js.map +1 -0
  27. package/esm/src/funcs/getBestAnswer.d.ts +66 -0
  28. package/esm/src/funcs/getBestAnswer.d.ts.map +1 -0
  29. package/esm/src/funcs/getBestAnswer.js +148 -0
  30. package/esm/src/funcs/getBestAnswer.js.map +1 -0
  31. package/esm/src/funcs/getMyPortals.d.ts +97 -0
  32. package/esm/src/funcs/getMyPortals.d.ts.map +1 -0
  33. package/esm/src/funcs/getMyPortals.js +180 -0
  34. package/esm/src/funcs/getMyPortals.js.map +1 -0
  35. package/esm/src/funcs/getPopularArticles.d.ts +39 -0
  36. package/esm/src/funcs/getPopularArticles.d.ts.map +1 -1
  37. package/esm/src/funcs/getPopularArticles.js +47 -3
  38. package/esm/src/funcs/getPopularArticles.js.map +1 -1
  39. package/esm/src/funcs/getPortals.d.ts +26 -1
  40. package/esm/src/funcs/getPortals.d.ts.map +1 -1
  41. package/esm/src/funcs/getPortals.js +35 -10
  42. package/esm/src/funcs/getPortals.js.map +1 -1
  43. package/esm/src/funcs/makeSuggestion.d.ts +46 -2
  44. package/esm/src/funcs/makeSuggestion.d.ts.map +1 -1
  45. package/esm/src/funcs/makeSuggestion.js +51 -3
  46. package/esm/src/funcs/makeSuggestion.js.map +1 -1
  47. package/esm/src/funcs/queryAnswers.d.ts +41 -5
  48. package/esm/src/funcs/queryAnswers.d.ts.map +1 -1
  49. package/esm/src/funcs/queryAnswers.js +41 -5
  50. package/esm/src/funcs/queryAnswers.js.map +1 -1
  51. package/esm/src/funcs/queryRetrieve.d.ts +41 -1
  52. package/esm/src/funcs/queryRetrieve.d.ts.map +1 -1
  53. package/esm/src/funcs/queryRetrieve.js +41 -1
  54. package/esm/src/funcs/queryRetrieve.js.map +1 -1
  55. package/esm/src/funcs/querySearch.d.ts +48 -1
  56. package/esm/src/funcs/querySearch.d.ts.map +1 -1
  57. package/esm/src/funcs/querySearch.js +48 -1
  58. package/esm/src/funcs/querySearch.js.map +1 -1
  59. package/esm/src/funcs/retrieveChunks.d.ts +41 -7
  60. package/esm/src/funcs/retrieveChunks.d.ts.map +1 -1
  61. package/esm/src/funcs/retrieveChunks.js +45 -19
  62. package/esm/src/funcs/retrieveChunks.js.map +1 -1
  63. package/esm/src/hooks/auth-hook.d.ts +1 -2
  64. package/esm/src/hooks/auth-hook.d.ts.map +1 -1
  65. package/esm/src/hooks/auth-hook.js +1 -65
  66. package/esm/src/hooks/auth-hook.js.map +1 -1
  67. package/esm/src/hooks/registration.d.ts.map +1 -1
  68. package/esm/src/hooks/registration.js +2 -16
  69. package/esm/src/hooks/registration.js.map +1 -1
  70. package/esm/src/landing-page.d.ts +5 -0
  71. package/esm/src/landing-page.d.ts.map +1 -0
  72. package/esm/src/landing-page.js +1070 -0
  73. package/esm/src/landing-page.js.map +1 -0
  74. package/esm/src/lib/base64.d.ts +2 -2
  75. package/esm/src/lib/base64.d.ts.map +1 -1
  76. package/esm/src/lib/base64.js +2 -2
  77. package/esm/src/lib/base64.js.map +1 -1
  78. package/esm/src/lib/config.d.ts +3 -3
  79. package/esm/src/lib/config.js +5 -5
  80. package/esm/src/lib/config.js.map +1 -1
  81. package/esm/src/lib/encodings.d.ts.map +1 -1
  82. package/esm/src/lib/encodings.js +10 -1
  83. package/esm/src/lib/encodings.js.map +1 -1
  84. package/esm/src/lib/matchers.d.ts.map +1 -1
  85. package/esm/src/lib/matchers.js +4 -1
  86. package/esm/src/lib/matchers.js.map +1 -1
  87. package/esm/src/lib/schemas.d.ts +4 -4
  88. package/esm/src/lib/schemas.d.ts.map +1 -1
  89. package/esm/src/lib/schemas.js +2 -2
  90. package/esm/src/lib/schemas.js.map +1 -1
  91. package/esm/src/lib/sdks.js +2 -2
  92. package/esm/src/lib/sdks.js.map +1 -1
  93. package/esm/src/lib/security.d.ts.map +1 -1
  94. package/esm/src/lib/security.js +18 -0
  95. package/esm/src/lib/security.js.map +1 -1
  96. package/esm/src/mcp-server/cli/start/command.d.ts.map +1 -1
  97. package/esm/src/mcp-server/cli/start/command.js +30 -0
  98. package/esm/src/mcp-server/cli/start/command.js.map +1 -1
  99. package/esm/src/mcp-server/cli/start/impl.d.ts +2 -7
  100. package/esm/src/mcp-server/cli/start/impl.d.ts.map +1 -1
  101. package/esm/src/mcp-server/cli/start/impl.js +98 -22
  102. package/esm/src/mcp-server/cli/start/impl.js.map +1 -1
  103. package/esm/src/mcp-server/extensions.d.ts +4 -4
  104. package/esm/src/mcp-server/extensions.d.ts.map +1 -1
  105. package/esm/src/mcp-server/flags.d.ts +17 -0
  106. package/esm/src/mcp-server/flags.d.ts.map +1 -0
  107. package/esm/src/mcp-server/flags.js +5 -0
  108. package/esm/src/mcp-server/flags.js.map +1 -0
  109. package/esm/src/mcp-server/mcp-server.js +1 -1
  110. package/esm/src/mcp-server/mcp-server.js.map +1 -1
  111. package/esm/src/mcp-server/prompts.d.ts +4 -7
  112. package/esm/src/mcp-server/prompts.d.ts.map +1 -1
  113. package/esm/src/mcp-server/prompts.js.map +1 -1
  114. package/esm/src/mcp-server/server.d.ts +8 -1
  115. package/esm/src/mcp-server/server.d.ts.map +1 -1
  116. package/esm/src/mcp-server/server.js +19 -16
  117. package/esm/src/mcp-server/server.js.map +1 -1
  118. package/esm/src/mcp-server/tools/aiSearch.d.ts +7 -0
  119. package/esm/src/mcp-server/tools/aiSearch.d.ts.map +1 -0
  120. package/esm/src/mcp-server/tools/aiSearch.js +83 -0
  121. package/esm/src/mcp-server/tools/aiSearch.js.map +1 -0
  122. package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts +7 -0
  123. package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts.map +1 -0
  124. package/esm/src/mcp-server/tools/getAnnouncementArticles.js +81 -0
  125. package/esm/src/mcp-server/tools/getAnnouncementArticles.js.map +1 -0
  126. package/esm/src/mcp-server/tools/getAnnouncements.d.ts.map +1 -1
  127. package/esm/src/mcp-server/tools/getAnnouncements.js +39 -1
  128. package/esm/src/mcp-server/tools/getAnnouncements.js.map +1 -1
  129. package/esm/src/mcp-server/tools/getArticle.d.ts.map +1 -1
  130. package/esm/src/mcp-server/tools/getArticle.js +42 -0
  131. package/esm/src/mcp-server/tools/getArticle.js.map +1 -1
  132. package/esm/src/mcp-server/tools/getArticleById.d.ts +7 -0
  133. package/esm/src/mcp-server/tools/getArticleById.d.ts.map +1 -0
  134. package/esm/src/mcp-server/tools/getArticleById.js +90 -0
  135. package/esm/src/mcp-server/tools/getArticleById.js.map +1 -0
  136. package/esm/src/mcp-server/tools/getBestAnswer.d.ts +7 -0
  137. package/esm/src/mcp-server/tools/getBestAnswer.d.ts.map +1 -0
  138. package/esm/src/mcp-server/tools/getBestAnswer.js +85 -0
  139. package/esm/src/mcp-server/tools/getBestAnswer.js.map +1 -0
  140. package/esm/src/mcp-server/tools/getMyPortals.d.ts +7 -0
  141. package/esm/src/mcp-server/tools/getMyPortals.d.ts.map +1 -0
  142. package/esm/src/mcp-server/tools/getMyPortals.js +117 -0
  143. package/esm/src/mcp-server/tools/getMyPortals.js.map +1 -0
  144. package/esm/src/mcp-server/tools/getPopularArticles.d.ts +1 -1
  145. package/esm/src/mcp-server/tools/getPopularArticles.d.ts.map +1 -1
  146. package/esm/src/mcp-server/tools/getPopularArticles.js +40 -0
  147. package/esm/src/mcp-server/tools/getPopularArticles.js.map +1 -1
  148. package/esm/src/mcp-server/tools/getPortals.d.ts +1 -1
  149. package/esm/src/mcp-server/tools/getPortals.d.ts.map +1 -1
  150. package/esm/src/mcp-server/tools/getPortals.js +26 -1
  151. package/esm/src/mcp-server/tools/getPortals.js.map +1 -1
  152. package/esm/src/mcp-server/tools/makeSuggestion.d.ts +1 -1
  153. package/esm/src/mcp-server/tools/makeSuggestion.d.ts.map +1 -1
  154. package/esm/src/mcp-server/tools/makeSuggestion.js +44 -0
  155. package/esm/src/mcp-server/tools/makeSuggestion.js.map +1 -1
  156. package/esm/src/mcp-server/tools/queryAnswers.d.ts.map +1 -1
  157. package/esm/src/mcp-server/tools/queryAnswers.js +41 -5
  158. package/esm/src/mcp-server/tools/queryAnswers.js.map +1 -1
  159. package/esm/src/mcp-server/tools/queryRetrieve.d.ts.map +1 -1
  160. package/esm/src/mcp-server/tools/queryRetrieve.js +41 -1
  161. package/esm/src/mcp-server/tools/queryRetrieve.js.map +1 -1
  162. package/esm/src/mcp-server/tools/querySearch.d.ts.map +1 -1
  163. package/esm/src/mcp-server/tools/querySearch.js +48 -1
  164. package/esm/src/mcp-server/tools/querySearch.js.map +1 -1
  165. package/esm/src/mcp-server/tools/retrieveChunks.d.ts +1 -1
  166. package/esm/src/mcp-server/tools/retrieveChunks.d.ts.map +1 -1
  167. package/esm/src/mcp-server/tools/retrieveChunks.js +41 -7
  168. package/esm/src/mcp-server/tools/retrieveChunks.js.map +1 -1
  169. package/esm/src/mcp-server/tools.d.ts +14 -4
  170. package/esm/src/mcp-server/tools.d.ts.map +1 -1
  171. package/esm/src/mcp-server/tools.js +203 -5
  172. package/esm/src/mcp-server/tools.js.map +1 -1
  173. package/esm/src/models/acceptlanguage.d.ts +36 -5
  174. package/esm/src/models/acceptlanguage.d.ts.map +1 -1
  175. package/esm/src/models/acceptlanguage.js +18 -4
  176. package/esm/src/models/acceptlanguage.js.map +1 -1
  177. package/esm/src/models/accessibleportal.d.ts +1 -1
  178. package/esm/src/models/accessibleportal.d.ts.map +1 -1
  179. package/esm/src/models/accessibleportal.js.map +1 -1
  180. package/esm/src/models/additionalsnippets.d.ts +18 -3
  181. package/esm/src/models/additionalsnippets.d.ts.map +1 -1
  182. package/esm/src/models/additionalsnippets.js +8 -1
  183. package/esm/src/models/additionalsnippets.js.map +1 -1
  184. package/esm/src/models/aisearchop.d.ts +4 -10
  185. package/esm/src/models/aisearchop.d.ts.map +1 -1
  186. package/esm/src/models/aisearchop.js +9 -20
  187. package/esm/src/models/aisearchop.js.map +1 -1
  188. package/esm/src/models/aisearchresponse.d.ts +2 -2
  189. package/esm/src/models/aisearchresponse.d.ts.map +1 -1
  190. package/esm/src/models/aisearchresponse.js.map +1 -1
  191. package/esm/src/models/aispaginationinfo.d.ts +1 -1
  192. package/esm/src/models/aispaginationinfo.d.ts.map +1 -1
  193. package/esm/src/models/aispaginationinfo.js +5 -4
  194. package/esm/src/models/aispaginationinfo.js.map +1 -1
  195. package/esm/src/models/aitopicbreadcrumb.d.ts +1 -1
  196. package/esm/src/models/aitopicbreadcrumb.d.ts.map +1 -1
  197. package/esm/src/models/aitopicbreadcrumb.js +2 -1
  198. package/esm/src/models/aitopicbreadcrumb.js.map +1 -1
  199. package/esm/src/models/aitopicsummary.d.ts +1 -1
  200. package/esm/src/models/aitopicsummary.d.ts.map +1 -1
  201. package/esm/src/models/aitopicsummary.js.map +1 -1
  202. package/esm/src/models/allaccessibleportals.d.ts +1 -1
  203. package/esm/src/models/allaccessibleportals.d.ts.map +1 -1
  204. package/esm/src/models/allaccessibleportals.js +2 -1
  205. package/esm/src/models/allaccessibleportals.js.map +1 -1
  206. package/esm/src/models/answersrequest.d.ts +16 -25
  207. package/esm/src/models/answersrequest.d.ts.map +1 -1
  208. package/esm/src/models/answersrequest.js +11 -25
  209. package/esm/src/models/answersrequest.js.map +1 -1
  210. package/esm/src/models/answersresponse.d.ts +28 -7
  211. package/esm/src/models/answersresponse.d.ts.map +1 -1
  212. package/esm/src/models/answersresponse.js +8 -0
  213. package/esm/src/models/answersresponse.js.map +1 -1
  214. package/esm/src/models/article.d.ts +2 -2
  215. package/esm/src/models/article.d.ts.map +1 -1
  216. package/esm/src/models/article.js +3 -4
  217. package/esm/src/models/article.js.map +1 -1
  218. package/esm/src/models/articleadditionalattributes.d.ts +36 -2
  219. package/esm/src/models/articleadditionalattributes.d.ts.map +1 -1
  220. package/esm/src/models/articleadditionalattributes.js +17 -0
  221. package/esm/src/models/articleadditionalattributes.js.map +1 -1
  222. package/esm/src/models/articleaisearchresult.d.ts +48 -9
  223. package/esm/src/models/articleaisearchresult.d.ts.map +1 -1
  224. package/esm/src/models/articleaisearchresult.js +17 -1
  225. package/esm/src/models/articleaisearchresult.js.map +1 -1
  226. package/esm/src/models/articleattachment.d.ts +14 -3
  227. package/esm/src/models/articleattachment.d.ts.map +1 -1
  228. package/esm/src/models/articleattachment.js +7 -2
  229. package/esm/src/models/articleattachment.js.map +1 -1
  230. package/esm/src/models/articleresult.d.ts +1 -1
  231. package/esm/src/models/articleresult.d.ts.map +1 -1
  232. package/esm/src/models/articleresult.js +1 -1
  233. package/esm/src/models/articleresult.js.map +1 -1
  234. package/esm/src/models/articleresultadditionalattributes.d.ts +34 -2
  235. package/esm/src/models/articleresultadditionalattributes.d.ts.map +1 -1
  236. package/esm/src/models/articleresultadditionalattributes.js +16 -0
  237. package/esm/src/models/articleresultadditionalattributes.js.map +1 -1
  238. package/esm/src/models/articleresults.d.ts +1 -1
  239. package/esm/src/models/articleresults.d.ts.map +1 -1
  240. package/esm/src/models/articleresults.js.map +1 -1
  241. package/esm/src/models/articletype.d.ts +2 -7
  242. package/esm/src/models/articletype.d.ts.map +1 -1
  243. package/esm/src/models/articletype.js +2 -16
  244. package/esm/src/models/articletype.js.map +1 -1
  245. package/esm/src/models/attachmentforcreatesuggestion.d.ts +1 -1
  246. package/esm/src/models/attachmentforcreatesuggestion.d.ts.map +1 -1
  247. package/esm/src/models/attachmentforcreatesuggestion.js.map +1 -1
  248. package/esm/src/models/bookmarkstatus.d.ts +1 -1
  249. package/esm/src/models/bookmarkstatus.d.ts.map +1 -1
  250. package/esm/src/models/bookmarkstatus.js +1 -1
  251. package/esm/src/models/bookmarkstatus.js.map +1 -1
  252. package/esm/src/models/complianceforarticle.d.ts +3 -3
  253. package/esm/src/models/complianceforarticle.d.ts.map +1 -1
  254. package/esm/src/models/complianceforarticle.js +8 -5
  255. package/esm/src/models/complianceforarticle.js.map +1 -1
  256. package/esm/src/models/createdby.d.ts +1 -1
  257. package/esm/src/models/createdby.d.ts.map +1 -1
  258. package/esm/src/models/createdby.js.map +1 -1
  259. package/esm/src/models/createsuggestion.d.ts +69 -6
  260. package/esm/src/models/createsuggestion.d.ts.map +1 -1
  261. package/esm/src/models/createsuggestion.js +31 -2
  262. package/esm/src/models/createsuggestion.js.map +1 -1
  263. package/esm/src/models/customattribute.d.ts +18 -3
  264. package/esm/src/models/customattribute.d.ts.map +1 -1
  265. package/esm/src/models/customattribute.js +6 -0
  266. package/esm/src/models/customattribute.js.map +1 -1
  267. package/esm/src/models/department.d.ts +1 -1
  268. package/esm/src/models/department.d.ts.map +1 -1
  269. package/esm/src/models/department.js.map +1 -1
  270. package/esm/src/models/edition.d.ts +2 -2
  271. package/esm/src/models/edition.d.ts.map +1 -1
  272. package/esm/src/models/edition.js +1 -2
  273. package/esm/src/models/edition.js.map +1 -1
  274. package/esm/src/models/errors/sdkvalidationerror.d.ts +1 -1
  275. package/esm/src/models/errors/sdkvalidationerror.d.ts.map +1 -1
  276. package/esm/src/models/errors/sdkvalidationerror.js +2 -49
  277. package/esm/src/models/errors/sdkvalidationerror.js.map +1 -1
  278. package/esm/src/models/folderbreadcrumb.d.ts +1 -1
  279. package/esm/src/models/folderbreadcrumb.d.ts.map +1 -1
  280. package/esm/src/models/folderbreadcrumb.js.map +1 -1
  281. package/esm/src/models/foldersummary.d.ts +1 -1
  282. package/esm/src/models/foldersummary.d.ts.map +1 -1
  283. package/esm/src/models/foldersummary.js +1 -1
  284. package/esm/src/models/foldersummary.js.map +1 -1
  285. package/esm/src/models/getannouncementarticlesop.d.ts +8 -9
  286. package/esm/src/models/getannouncementarticlesop.d.ts.map +1 -1
  287. package/esm/src/models/getannouncementarticlesop.js +12 -10
  288. package/esm/src/models/getannouncementarticlesop.js.map +1 -1
  289. package/esm/src/models/getarticlebyidop.d.ts +77 -11
  290. package/esm/src/models/getarticlebyidop.d.ts.map +1 -1
  291. package/esm/src/models/getarticlebyidop.js +31 -62
  292. package/esm/src/models/getarticlebyidop.js.map +1 -1
  293. package/esm/src/models/getbestanswerop.d.ts +1 -9
  294. package/esm/src/models/getbestanswerop.d.ts.map +1 -1
  295. package/esm/src/models/getbestanswerop.js +3 -16
  296. package/esm/src/models/getbestanswerop.js.map +1 -1
  297. package/esm/src/models/getmyportalsop.d.ts +4 -10
  298. package/esm/src/models/getmyportalsop.d.ts.map +1 -1
  299. package/esm/src/models/getmyportalsop.js +9 -10
  300. package/esm/src/models/getmyportalsop.js.map +1 -1
  301. package/esm/src/models/getpopulararticlesop.d.ts +8 -9
  302. package/esm/src/models/getpopulararticlesop.d.ts.map +1 -1
  303. package/esm/src/models/getpopulararticlesop.js +12 -10
  304. package/esm/src/models/getpopulararticlesop.js.map +1 -1
  305. package/esm/src/models/l10nstring.d.ts +1 -1
  306. package/esm/src/models/l10nstring.d.ts.map +1 -1
  307. package/esm/src/models/l10nstring.js.map +1 -1
  308. package/esm/src/models/languagecode.d.ts +69 -2
  309. package/esm/src/models/languagecode.d.ts.map +1 -1
  310. package/esm/src/models/languagecode.js +32 -0
  311. package/esm/src/models/languagecode.js.map +1 -1
  312. package/esm/src/models/languagecodeparameter.d.ts +90 -5
  313. package/esm/src/models/languagecodeparameter.d.ts.map +1 -1
  314. package/esm/src/models/languagecodeparameter.js +45 -4
  315. package/esm/src/models/languagecodeparameter.js.map +1 -1
  316. package/esm/src/models/languagequeryparameter.d.ts +90 -5
  317. package/esm/src/models/languagequeryparameter.d.ts.map +1 -1
  318. package/esm/src/models/languagequeryparameter.js +45 -4
  319. package/esm/src/models/languagequeryparameter.js.map +1 -1
  320. package/esm/src/models/link.d.ts +1 -1
  321. package/esm/src/models/link.d.ts.map +1 -1
  322. package/esm/src/models/link.js.map +1 -1
  323. package/esm/src/models/makesuggestionop.d.ts +4 -9
  324. package/esm/src/models/makesuggestionop.d.ts.map +1 -1
  325. package/esm/src/models/makesuggestionop.js +3 -7
  326. package/esm/src/models/makesuggestionop.js.map +1 -1
  327. package/esm/src/models/mandatorylanguagequeryparameter.d.ts +90 -5
  328. package/esm/src/models/mandatorylanguagequeryparameter.d.ts.map +1 -1
  329. package/esm/src/models/mandatorylanguagequeryparameter.js +45 -4
  330. package/esm/src/models/mandatorylanguagequeryparameter.js.map +1 -1
  331. package/esm/src/models/milestone.d.ts +1 -1
  332. package/esm/src/models/milestone.d.ts.map +1 -1
  333. package/esm/src/models/milestone.js.map +1 -1
  334. package/esm/src/models/milestonename.d.ts +1 -1
  335. package/esm/src/models/milestonename.d.ts.map +1 -1
  336. package/esm/src/models/milestonename.js.map +1 -1
  337. package/esm/src/models/modifiedby.d.ts +1 -1
  338. package/esm/src/models/modifiedby.d.ts.map +1 -1
  339. package/esm/src/models/modifiedby.js.map +1 -1
  340. package/esm/src/models/order.d.ts +10 -2
  341. package/esm/src/models/order.d.ts.map +1 -1
  342. package/esm/src/models/order.js +4 -0
  343. package/esm/src/models/order.js.map +1 -1
  344. package/esm/src/models/ownedby.d.ts +1 -1
  345. package/esm/src/models/ownedby.d.ts.map +1 -1
  346. package/esm/src/models/ownedby.js +1 -2
  347. package/esm/src/models/ownedby.js.map +1 -1
  348. package/esm/src/models/paginationinfo.d.ts +1 -1
  349. package/esm/src/models/paginationinfo.d.ts.map +1 -1
  350. package/esm/src/models/paginationinfo.js +3 -3
  351. package/esm/src/models/paginationinfo.js.map +1 -1
  352. package/esm/src/models/personalization.d.ts +4 -4
  353. package/esm/src/models/personalization.d.ts.map +1 -1
  354. package/esm/src/models/personalization.js +1 -2
  355. package/esm/src/models/personalization.js.map +1 -1
  356. package/esm/src/models/publishview.d.ts +2 -2
  357. package/esm/src/models/publishview.d.ts.map +1 -1
  358. package/esm/src/models/publishview.js.map +1 -1
  359. package/esm/src/models/referenceresponse.d.ts +30 -5
  360. package/esm/src/models/referenceresponse.d.ts.map +1 -1
  361. package/esm/src/models/referenceresponse.js +12 -1
  362. package/esm/src/models/referenceresponse.js.map +1 -1
  363. package/esm/src/models/requiredlanguagecode.d.ts +71 -2
  364. package/esm/src/models/requiredlanguagecode.d.ts.map +1 -1
  365. package/esm/src/models/requiredlanguagecode.js +33 -0
  366. package/esm/src/models/requiredlanguagecode.js.map +1 -1
  367. package/esm/src/models/retrievechunksop.d.ts +1 -9
  368. package/esm/src/models/retrievechunksop.d.ts.map +1 -1
  369. package/esm/src/models/retrievechunksop.js +1 -15
  370. package/esm/src/models/retrievechunksop.js.map +1 -1
  371. package/esm/src/models/retrieverequest.d.ts +15 -4
  372. package/esm/src/models/retrieverequest.d.ts.map +1 -1
  373. package/esm/src/models/retrieverequest.js +4 -0
  374. package/esm/src/models/retrieverequest.js.map +1 -1
  375. package/esm/src/models/retrieveresponse.d.ts +27 -8
  376. package/esm/src/models/retrieveresponse.d.ts.map +1 -1
  377. package/esm/src/models/retrieveresponse.js +8 -1
  378. package/esm/src/models/retrieveresponse.js.map +1 -1
  379. package/esm/src/models/schemaslink.d.ts +1 -1
  380. package/esm/src/models/schemaslink.d.ts.map +1 -1
  381. package/esm/src/models/schemaslink.js.map +1 -1
  382. package/esm/src/models/schemastags.d.ts +1 -1
  383. package/esm/src/models/schemastags.d.ts.map +1 -1
  384. package/esm/src/models/schemastags.js.map +1 -1
  385. package/esm/src/models/searchresult.d.ts +40 -5
  386. package/esm/src/models/searchresult.d.ts.map +1 -1
  387. package/esm/src/models/searchresult.js +19 -0
  388. package/esm/src/models/searchresult.js.map +1 -1
  389. package/esm/src/models/security.d.ts +5 -2
  390. package/esm/src/models/security.d.ts.map +1 -1
  391. package/esm/src/models/security.js +5 -3
  392. package/esm/src/models/security.js.map +1 -1
  393. package/esm/src/models/shorturl.d.ts +1 -1
  394. package/esm/src/models/shorturl.d.ts.map +1 -1
  395. package/esm/src/models/shorturl.js +1 -2
  396. package/esm/src/models/shorturl.js.map +1 -1
  397. package/esm/src/models/sortidnamedepartment.d.ts +12 -2
  398. package/esm/src/models/sortidnamedepartment.d.ts.map +1 -1
  399. package/esm/src/models/sortidnamedepartment.js +5 -0
  400. package/esm/src/models/sortidnamedepartment.js.map +1 -1
  401. package/esm/src/models/stage.d.ts +1 -1
  402. package/esm/src/models/stage.d.ts.map +1 -1
  403. package/esm/src/models/stage.js +1 -2
  404. package/esm/src/models/stage.js.map +1 -1
  405. package/esm/src/models/structuredauthoringfields.d.ts +1 -1
  406. package/esm/src/models/structuredauthoringfields.d.ts.map +1 -1
  407. package/esm/src/models/structuredauthoringfields.js.map +1 -1
  408. package/esm/src/models/tag.d.ts +1 -1
  409. package/esm/src/models/tag.d.ts.map +1 -1
  410. package/esm/src/models/tag.js.map +1 -1
  411. package/esm/src/models/tagcategory.d.ts +1 -1
  412. package/esm/src/models/tagcategory.d.ts.map +1 -1
  413. package/esm/src/models/tagcategory.js.map +1 -1
  414. package/esm/src/models/taggroup.d.ts +1 -1
  415. package/esm/src/models/taggroup.d.ts.map +1 -1
  416. package/esm/src/models/taggroup.js +1 -2
  417. package/esm/src/models/taggroup.js.map +1 -1
  418. package/esm/src/models/taggroups.d.ts +1 -1
  419. package/esm/src/models/taggroups.d.ts.map +1 -1
  420. package/esm/src/models/taggroups.js.map +1 -1
  421. package/esm/src/models/tags.d.ts +1 -1
  422. package/esm/src/models/tags.d.ts.map +1 -1
  423. package/esm/src/models/tags.js.map +1 -1
  424. package/esm/src/models/topicbreadcrumb.d.ts +1 -1
  425. package/esm/src/models/topicbreadcrumb.d.ts.map +1 -1
  426. package/esm/src/models/topicbreadcrumb.js.map +1 -1
  427. package/esm/src/models/topicsummary.d.ts +1 -1
  428. package/esm/src/models/topicsummary.d.ts.map +1 -1
  429. package/esm/src/models/topicsummary.js.map +1 -1
  430. package/esm/src/models/workflow.d.ts +1 -1
  431. package/esm/src/models/workflow.d.ts.map +1 -1
  432. package/esm/src/models/workflow.js +1 -2
  433. package/esm/src/models/workflow.js.map +1 -1
  434. package/esm/src/models/workflowmilestone.d.ts +12 -2
  435. package/esm/src/models/workflowmilestone.d.ts.map +1 -1
  436. package/esm/src/models/workflowmilestone.js +5 -0
  437. package/esm/src/models/workflowmilestone.js.map +1 -1
  438. package/esm/src/models/wserrorcommon.d.ts +2 -2
  439. package/esm/src/models/wserrorcommon.d.ts.map +1 -1
  440. package/esm/src/models/wserrorcommon.js +1 -2
  441. package/esm/src/models/wserrorcommon.js.map +1 -1
  442. package/esm/src/tool-names.d.ts +5 -0
  443. package/esm/src/tool-names.d.ts.map +1 -0
  444. package/esm/src/tool-names.js +36 -0
  445. package/esm/src/tool-names.js.map +1 -0
  446. package/esm/src/types/bigint.d.ts +6 -0
  447. package/esm/src/types/bigint.d.ts.map +1 -0
  448. package/esm/src/types/bigint.js +87 -0
  449. package/esm/src/types/bigint.js.map +1 -0
  450. package/esm/worker-configuration.d.ts +1 -0
  451. package/esm/worker-configuration.d.ts.map +1 -1
  452. package/manifest.json +78 -51
  453. package/package.json +11 -7
  454. package/src/cloudflare-worker/cloudflare-worker.ts +22 -9
  455. package/src/funcs/{querySearch.ts → aiSearch.ts} +49 -2
  456. package/src/funcs/{getAnnouncements.ts → getAnnouncementArticles.ts} +67 -10
  457. package/src/funcs/{getArticle.ts → getArticleById.ts} +58 -1
  458. package/src/funcs/{queryAnswers.ts → getBestAnswer.ts} +52 -14
  459. package/src/funcs/{getPortals.ts → getMyPortals.ts} +35 -2
  460. package/src/funcs/getPopularArticles.ts +68 -8
  461. package/src/funcs/makeSuggestion.ts +67 -9
  462. package/src/funcs/{queryRetrieve.ts → retrieveChunks.ts} +50 -15
  463. package/src/hooks/auth-hook.ts +3 -63
  464. package/src/hooks/registration.ts +3 -18
  465. package/src/landing-page.ts +1084 -0
  466. package/src/lib/base64.ts +2 -2
  467. package/src/lib/config.ts +5 -5
  468. package/src/lib/encodings.ts +12 -3
  469. package/src/lib/matchers.ts +5 -1
  470. package/src/lib/schemas.ts +10 -22
  471. package/src/lib/sdks.ts +2 -2
  472. package/src/lib/security.ts +21 -0
  473. package/src/mcp-server/cli/start/command.ts +31 -0
  474. package/src/mcp-server/cli/start/impl.ts +118 -31
  475. package/src/mcp-server/extensions.ts +6 -4
  476. package/src/mcp-server/flags.ts +21 -0
  477. package/src/mcp-server/mcp-server.ts +1 -1
  478. package/src/mcp-server/prompts.ts +9 -19
  479. package/src/mcp-server/server.ts +22 -16
  480. package/src/mcp-server/tools/aiSearch.ts +92 -0
  481. package/src/mcp-server/tools/getAnnouncementArticles.ts +90 -0
  482. package/src/mcp-server/tools/getArticleById.ts +99 -0
  483. package/src/mcp-server/tools/getBestAnswer.ts +94 -0
  484. package/src/mcp-server/tools/{getPortals.ts → getMyPortals.ts} +39 -5
  485. package/src/mcp-server/tools/getPopularArticles.ts +40 -0
  486. package/src/mcp-server/tools/makeSuggestion.ts +44 -0
  487. package/src/mcp-server/tools/retrieveChunks.ts +89 -0
  488. package/src/mcp-server/tools.ts +300 -46
  489. package/src/models/acceptlanguage.ts +21 -8
  490. package/src/models/accessibleportal.ts +9 -11
  491. package/src/models/additionalsnippets.ts +25 -18
  492. package/src/models/aisearchop.ts +14 -37
  493. package/src/models/aisearchresponse.ts +7 -13
  494. package/src/models/aispaginationinfo.ts +7 -10
  495. package/src/models/aitopicbreadcrumb.ts +4 -7
  496. package/src/models/aitopicsummary.ts +1 -5
  497. package/src/models/allaccessibleportals.ts +5 -8
  498. package/src/models/answersrequest.ts +22 -58
  499. package/src/models/answersresponse.ts +30 -24
  500. package/src/models/article.ts +39 -40
  501. package/src/models/articleadditionalattributes.ts +22 -4
  502. package/src/models/articleaisearchresult.ts +70 -52
  503. package/src/models/articleattachment.ts +18 -15
  504. package/src/models/articleresult.ts +2 -6
  505. package/src/models/articleresultadditionalattributes.ts +43 -0
  506. package/src/models/articleresults.ts +1 -5
  507. package/src/models/articletype.ts +4 -25
  508. package/src/models/attachmentforcreatesuggestion.ts +1 -3
  509. package/src/models/bookmarkstatus.ts +2 -6
  510. package/src/models/complianceforarticle.ts +13 -22
  511. package/src/models/createdby.ts +7 -8
  512. package/src/models/createsuggestion.ts +54 -31
  513. package/src/models/customattribute.ts +13 -7
  514. package/src/models/department.ts +1 -5
  515. package/src/models/edition.ts +8 -13
  516. package/src/models/errors/sdkvalidationerror.ts +2 -57
  517. package/src/models/folderbreadcrumb.ts +5 -7
  518. package/src/models/foldersummary.ts +2 -6
  519. package/src/models/getannouncementarticlesop.ts +34 -23
  520. package/src/models/getarticlebyidop.ts +91 -95
  521. package/src/models/getbestanswerop.ts +16 -48
  522. package/src/models/getmyportalsop.ts +29 -44
  523. package/src/models/getpopulararticlesop.ts +34 -23
  524. package/src/models/l10nstring.ts +1 -5
  525. package/src/models/languagecode.ts +38 -2
  526. package/src/models/languagecodeparameter.ts +48 -10
  527. package/src/models/languagequeryparameter.ts +48 -10
  528. package/src/models/link.ts +1 -1
  529. package/src/models/makesuggestionop.ts +20 -30
  530. package/src/models/mandatorylanguagequeryparameter.ts +50 -10
  531. package/src/models/milestone.ts +3 -4
  532. package/src/models/milestonename.ts +1 -5
  533. package/src/models/modifiedby.ts +1 -5
  534. package/src/models/order.ts +7 -2
  535. package/src/models/ownedby.ts +7 -8
  536. package/src/models/paginationinfo.ts +4 -8
  537. package/src/models/personalization.ts +6 -19
  538. package/src/models/publishview.ts +2 -8
  539. package/src/models/referenceresponse.ts +34 -20
  540. package/src/models/requiredlanguagecode.ts +39 -4
  541. package/src/models/retrievechunksop.ts +16 -48
  542. package/src/models/retrieverequest.ts +12 -10
  543. package/src/models/retrieveresponse.ts +34 -28
  544. package/src/models/schemaslink.ts +1 -5
  545. package/src/models/schemastags.ts +1 -5
  546. package/src/models/searchresult.ts +34 -8
  547. package/src/models/security.ts +14 -7
  548. package/src/models/shorturl.ts +6 -7
  549. package/src/models/sortidnamedepartment.ts +8 -4
  550. package/src/models/stage.ts +4 -5
  551. package/src/models/structuredauthoringfields.ts +1 -3
  552. package/src/models/tag.ts +1 -1
  553. package/src/models/tagcategory.ts +1 -5
  554. package/src/models/taggroup.ts +4 -5
  555. package/src/models/taggroups.ts +3 -4
  556. package/src/models/tags.ts +1 -1
  557. package/src/models/topicbreadcrumb.ts +1 -5
  558. package/src/models/topicsummary.ts +1 -5
  559. package/src/models/workflow.ts +3 -4
  560. package/src/models/workflowmilestone.ts +8 -2
  561. package/src/models/wserrorcommon.ts +5 -10
  562. package/src/tool-names.ts +35 -0
  563. package/src/types/bigint.ts +87 -0
  564. package/tsconfig.json +0 -1
  565. package/worker-configuration.d.ts +2 -2
  566. package/worker-configuration.ts +1 -0
  567. package/src/cloudflare-worker/landing-page.ts +0 -337
  568. package/src/hooks/portal-cache-hook.ts +0 -505
  569. package/src/hooks/portal-lookup-hook.ts +0 -429
  570. package/src/mcp-server/tools/getAnnouncements.ts +0 -53
  571. package/src/mcp-server/tools/getArticle.ts +0 -56
  572. package/src/mcp-server/tools/queryAnswers.ts +0 -57
  573. package/src/mcp-server/tools/queryRetrieve.ts +0 -55
  574. package/src/mcp-server/tools/querySearch.ts +0 -44
@@ -12,11 +12,7 @@ export type AITopicSummary = {
12
12
  name?: string | undefined;
13
13
  };
14
14
 
15
- export const AITopicSummary$zodSchema: z.ZodType<
16
- AITopicSummary,
17
- z.ZodTypeDef,
18
- unknown
19
- > = z.object({
15
+ export const AITopicSummary$zodSchema: z.ZodType<AITopicSummary> = z.object({
20
16
  id: z.string().optional(),
21
17
  name: z.string().optional(),
22
18
  }).describe(
@@ -17,11 +17,8 @@ export type AllAccessiblePortals = {
17
17
  paginationInfo?: PaginationInfo | undefined;
18
18
  };
19
19
 
20
- export const AllAccessiblePortals$zodSchema: z.ZodType<
21
- AllAccessiblePortals,
22
- z.ZodTypeDef,
23
- unknown
24
- > = z.object({
25
- paginationInfo: PaginationInfo$zodSchema.optional(),
26
- portal: z.array(AccessiblePortal$zodSchema).optional(),
27
- }).describe("Success");
20
+ export const AllAccessiblePortals$zodSchema: z.ZodType<AllAccessiblePortals> = z
21
+ .object({
22
+ paginationInfo: PaginationInfo$zodSchema.optional(),
23
+ portal: z.array(AccessiblePortal$zodSchema).optional(),
24
+ }).describe("Success");
@@ -3,84 +3,48 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
6
7
 
7
8
  /**
8
- * Optional channel type. Defaults to "portal" if omitted.
9
- *
10
- * @remarks
11
- * Accepts "portal" or "custom". Only include if channel object is provided.
9
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
12
10
  */
11
+ export const AnswersRequestType = {
12
+ Portal: "portal",
13
+ Custom: "custom",
14
+ } as const;
15
+ /**
16
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
17
+ */
18
+ export type AnswersRequestType = ClosedEnum<typeof AnswersRequestType>;
19
+
13
20
  export const AnswersRequestType$zodSchema = z.enum([
14
21
  "portal",
15
22
  "custom",
16
23
  ]).describe(
17
- "Optional channel type. Defaults to \"portal\" if omitted. \n"
18
- + "Accepts \"portal\" or \"custom\". Only include if channel object is provided.\n"
19
- + "",
24
+ "The channel where the query originated, e.g., directly from the portal or via a custom integration.",
20
25
  );
21
26
 
22
- export type AnswersRequestType = z.infer<typeof AnswersRequestType$zodSchema>;
23
-
24
- /**
25
- * **Optional** channel information. **Recommended: Omit this field** unless specifically needed.
26
- *
27
- * @remarks
28
- *
29
- * **Important Notes:**
30
- * - The API works reliably without this field (defaults are applied automatically)
31
- * - Including channel may cause validation errors (400 Bad Request) in some cases
32
- * - If you receive a 400 error when including channel, retry the request without it
33
- * - When channel is provided, both type and name are optional, but name should be non-empty if provided
34
- *
35
- * **Working examples:**
36
- * - Omit channel entirely (recommended)
37
- * - channel: {type: "portal", name: "portal"}
38
- * - channel: {type: "custom", name: "test"}
39
- * - channel: {name: "portal"} (type defaults to "portal")
40
- */
41
27
  export type AnswersRequestChannel = {
42
28
  type?: AnswersRequestType | undefined;
43
29
  name?: string | undefined;
44
30
  };
45
31
 
46
- export const AnswersRequestChannel$zodSchema: z.ZodType<
47
- AnswersRequestChannel,
48
- z.ZodTypeDef,
49
- unknown
50
- > = z.object({
51
- name: z.string().default("portal"),
52
- type: AnswersRequestType$zodSchema.default("portal"),
53
- }).describe(
54
- "**Optional** channel information. **Recommended: Omit this field** unless specifically needed.\n"
55
- + "\n"
56
- + "**Important Notes:**\n"
57
- + "- The API works reliably without this field (defaults are applied automatically)\n"
58
- + "- Including channel may cause validation errors (400 Bad Request) in some cases\n"
59
- + "- If you receive a 400 error when including channel, retry the request without it\n"
60
- + "- When channel is provided, both type and name are optional, but name should be non-empty if provided\n"
61
- + "\n"
62
- + "**Working examples:**\n"
63
- + "- Omit channel entirely (recommended)\n"
64
- + "- channel: {type: \"portal\", name: \"portal\"}\n"
65
- + "- channel: {type: \"custom\", name: \"test\"}\n"
66
- + "- channel: {name: \"portal\"} (type defaults to \"portal\")\n"
67
- + "",
68
- );
32
+ export const AnswersRequestChannel$zodSchema: z.ZodType<AnswersRequestChannel> =
33
+ z.object({
34
+ name: z.string().optional(),
35
+ type: AnswersRequestType$zodSchema.default("custom"),
36
+ });
69
37
 
70
38
  export type AnswersRequest = {
71
39
  channel?: AnswersRequestChannel | undefined;
72
- eventId: string;
40
+ eventId?: string | undefined;
73
41
  clientSessionId?: string | undefined;
74
- sessionId: string;
42
+ sessionId?: string | undefined;
75
43
  };
76
44
 
77
- export const AnswersRequest$zodSchema: z.ZodType<
78
- AnswersRequest,
79
- z.ZodTypeDef,
80
- unknown
81
- > = z.object({
45
+ export const AnswersRequest$zodSchema: z.ZodType<AnswersRequest> = z.object({
82
46
  channel: z.lazy(() => AnswersRequestChannel$zodSchema).optional(),
83
47
  clientSessionId: z.string().optional(),
84
- eventId: z.string(),
85
- sessionId: z.string(),
48
+ eventId: z.string().optional(),
49
+ sessionId: z.string().optional(),
86
50
  });
@@ -3,6 +3,7 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
6
7
  import {
7
8
  ReferenceResponse,
8
9
  ReferenceResponse$zodSchema,
@@ -12,6 +13,17 @@ import { SearchResult, SearchResult$zodSchema } from "./searchresult.js";
12
13
  /**
13
14
  * Indicates whether the answer was extracted directly from documents or generated by the LLM.
14
15
  */
16
+ export const AnswersResponseAnswerType = {
17
+ Certified: "certified",
18
+ Generative: "generative",
19
+ } as const;
20
+ /**
21
+ * Indicates whether the answer was extracted directly from documents or generated by the LLM.
22
+ */
23
+ export type AnswersResponseAnswerType = ClosedEnum<
24
+ typeof AnswersResponseAnswerType
25
+ >;
26
+
15
27
  export const AnswersResponseAnswerType$zodSchema = z.enum([
16
28
  "certified",
17
29
  "generative",
@@ -19,10 +31,6 @@ export const AnswersResponseAnswerType$zodSchema = z.enum([
19
31
  "Indicates whether the answer was extracted directly from documents or generated by the LLM.",
20
32
  );
21
33
 
22
- export type AnswersResponseAnswerType = z.infer<
23
- typeof AnswersResponseAnswerType$zodSchema
24
- >;
25
-
26
34
  export type AnswersResponseAnswer = {
27
35
  answerValue: string;
28
36
  references: Array<ReferenceResponse>;
@@ -30,20 +38,26 @@ export type AnswersResponseAnswer = {
30
38
  relevanceScore?: number | undefined;
31
39
  };
32
40
 
33
- export const AnswersResponseAnswer$zodSchema: z.ZodType<
34
- AnswersResponseAnswer,
35
- z.ZodTypeDef,
36
- unknown
37
- > = z.object({
38
- answerType: AnswersResponseAnswerType$zodSchema,
39
- answerValue: z.string(),
40
- references: z.array(ReferenceResponse$zodSchema),
41
- relevanceScore: z.number().optional(),
42
- });
41
+ export const AnswersResponseAnswer$zodSchema: z.ZodType<AnswersResponseAnswer> =
42
+ z.object({
43
+ answerType: AnswersResponseAnswerType$zodSchema,
44
+ answerValue: z.string(),
45
+ references: z.array(ReferenceResponse$zodSchema),
46
+ relevanceScore: z.number().optional(),
47
+ });
43
48
 
44
49
  /**
45
50
  * The channel where the query originated, e.g., directly from the portal or via a custom integration.
46
51
  */
52
+ export const AnswersResponseType = {
53
+ Portal: "portal",
54
+ Custom: "custom",
55
+ } as const;
56
+ /**
57
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
58
+ */
59
+ export type AnswersResponseType = ClosedEnum<typeof AnswersResponseType>;
60
+
47
61
  export const AnswersResponseType$zodSchema = z.enum([
48
62
  "portal",
49
63
  "custom",
@@ -51,17 +65,13 @@ export const AnswersResponseType$zodSchema = z.enum([
51
65
  "The channel where the query originated, e.g., directly from the portal or via a custom integration.",
52
66
  );
53
67
 
54
- export type AnswersResponseType = z.infer<typeof AnswersResponseType$zodSchema>;
55
-
56
68
  export type AnswersResponseChannel = {
57
69
  type: AnswersResponseType;
58
70
  name?: string | undefined;
59
71
  };
60
72
 
61
73
  export const AnswersResponseChannel$zodSchema: z.ZodType<
62
- AnswersResponseChannel,
63
- z.ZodTypeDef,
64
- unknown
74
+ AnswersResponseChannel
65
75
  > = z.object({
66
76
  name: z.string().optional(),
67
77
  type: AnswersResponseType$zodSchema,
@@ -76,11 +86,7 @@ export type AnswersResponse = {
76
86
  sessionId: string;
77
87
  };
78
88
 
79
- export const AnswersResponse$zodSchema: z.ZodType<
80
- AnswersResponse,
81
- z.ZodTypeDef,
82
- unknown
83
- > = z.object({
89
+ export const AnswersResponse$zodSchema: z.ZodType<AnswersResponse> = z.object({
84
90
  answer: z.lazy(() => AnswersResponseAnswer$zodSchema),
85
91
  channel: z.lazy(() => AnswersResponseChannel$zodSchema).optional(),
86
92
  clientSessionId: z.string().optional(),
@@ -71,7 +71,7 @@ export type Article = {
71
71
  structuredAuthoringFields?: StructuredAuthoringFields | undefined;
72
72
  articleState?: string | undefined;
73
73
  timesRated?: number | undefined;
74
- topicBreadcrumb: Array<TopicBreadcrumb>;
74
+ topicBreadcrumb?: Array<TopicBreadcrumb> | undefined;
75
75
  versionId?: string | undefined;
76
76
  workflow?: Workflow | undefined;
77
77
  compliance?: ComplianceForArticle | undefined;
@@ -79,42 +79,41 @@ export type Article = {
79
79
  bookmarkStatus?: BookmarkStatus | undefined;
80
80
  };
81
81
 
82
- export const Article$zodSchema: z.ZodType<Article, z.ZodTypeDef, unknown> = z
83
- .object({
84
- additionalInfo: z.string().optional(),
85
- articleKeywords: z.string().optional(),
86
- articleMacro: z.string().optional(),
87
- articleState: z.string().optional(),
88
- articleSummary: z.string().optional(),
89
- articleType: ArticleType$zodSchema.optional(),
90
- attachments: z.array(ArticleAttachment$zodSchema).optional(),
91
- availabilityDate: z.string().optional(),
92
- availableEditions: z.array(Edition$zodSchema).optional(),
93
- averageRating: z.number().optional(),
94
- bookmarkStatus: BookmarkStatus$zodSchema.optional(),
95
- compliance: ComplianceForArticle$zodSchema.optional(),
96
- content: z.string().optional(),
97
- contentText: z.string().optional(),
98
- createdBy: CreatedBy$zodSchema,
99
- createdDate: z.string().optional(),
100
- customAttributes: z.array(CustomAttribute$zodSchema).optional(),
101
- departmentID: z.string().optional(),
102
- description: z.string().optional(),
103
- expirationDate: z.string().optional(),
104
- id: z.string(),
105
- imageURL: z.string().optional(),
106
- includeInGenAI: z.boolean().optional(),
107
- isSubscribed: z.boolean().optional(),
108
- languageCode: LanguageCode$zodSchema.optional(),
109
- link: Link$zodSchema.optional(),
110
- modifiedBy: ModifiedBy$zodSchema.optional(),
111
- modifiedDate: z.string().optional(),
112
- name: z.string(),
113
- ownedBy: OwnedBy$zodSchema.optional(),
114
- personalization: Personalization$zodSchema.optional(),
115
- structuredAuthoringFields: StructuredAuthoringFields$zodSchema.optional(),
116
- timesRated: z.number().int().optional(),
117
- topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema),
118
- versionId: z.string().optional(),
119
- workflow: Workflow$zodSchema.optional(),
120
- }).describe("Success");
82
+ export const Article$zodSchema: z.ZodType<Article> = z.object({
83
+ additionalInfo: z.string().optional(),
84
+ articleKeywords: z.string().optional(),
85
+ articleMacro: z.string().optional(),
86
+ articleState: z.string().optional(),
87
+ articleSummary: z.string().optional(),
88
+ articleType: ArticleType$zodSchema.optional(),
89
+ attachments: z.array(ArticleAttachment$zodSchema).optional(),
90
+ availabilityDate: z.string().optional(),
91
+ availableEditions: z.array(Edition$zodSchema).optional(),
92
+ averageRating: z.number().optional(),
93
+ bookmarkStatus: BookmarkStatus$zodSchema.optional(),
94
+ compliance: ComplianceForArticle$zodSchema.optional(),
95
+ content: z.string().optional(),
96
+ contentText: z.string().optional(),
97
+ createdBy: CreatedBy$zodSchema,
98
+ createdDate: z.string().optional(),
99
+ customAttributes: z.array(CustomAttribute$zodSchema).optional(),
100
+ departmentID: z.string().optional(),
101
+ description: z.string().optional(),
102
+ expirationDate: z.string().optional(),
103
+ id: z.string(),
104
+ imageURL: z.string().optional(),
105
+ includeInGenAI: z.boolean().optional(),
106
+ isSubscribed: z.boolean().optional(),
107
+ languageCode: LanguageCode$zodSchema.optional(),
108
+ link: Link$zodSchema.optional(),
109
+ modifiedBy: ModifiedBy$zodSchema.optional(),
110
+ modifiedDate: z.string().optional(),
111
+ name: z.string(),
112
+ ownedBy: OwnedBy$zodSchema.optional(),
113
+ personalization: Personalization$zodSchema.optional(),
114
+ structuredAuthoringFields: StructuredAuthoringFields$zodSchema.optional(),
115
+ timesRated: z.int().optional(),
116
+ topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema).optional(),
117
+ versionId: z.string().optional(),
118
+ workflow: Workflow$zodSchema.optional(),
119
+ }).describe("Success");
@@ -3,6 +3,28 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
7
+
8
+ export const ArticleAdditionalAttributes = {
9
+ ArticleMacro: "articleMacro",
10
+ AvailabilityDate: "availabilityDate",
11
+ AvailableEditions: "availableEditions",
12
+ AverageRating: "averageRating",
13
+ BookmarkStatus: "bookmarkStatus",
14
+ Content: "content",
15
+ ContentText: "contentText",
16
+ Compliance: "compliance",
17
+ TimesRated: "timesRated",
18
+ CreatedByUserName: "createdBy.userName",
19
+ ModifiedByUserName: "modifiedBy.userName",
20
+ OwnedBy: "ownedBy",
21
+ OwnedByUserName: "ownedBy.userName",
22
+ Workflow: "workflow",
23
+ All: "all",
24
+ } as const;
25
+ export type ArticleAdditionalAttributes = ClosedEnum<
26
+ typeof ArticleAdditionalAttributes
27
+ >;
6
28
 
7
29
  export const ArticleAdditionalAttributes$zodSchema = z.enum([
8
30
  "articleMacro",
@@ -21,7 +43,3 @@ export const ArticleAdditionalAttributes$zodSchema = z.enum([
21
43
  "workflow",
22
44
  "all",
23
45
  ]);
24
-
25
- export type ArticleAdditionalAttributes = z.infer<
26
- typeof ArticleAdditionalAttributes$zodSchema
27
- >;
@@ -3,6 +3,7 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
6
7
  import {
7
8
  AdditionalSnippets,
8
9
  AdditionalSnippets$zodSchema,
@@ -16,6 +17,19 @@ import { SchemasTags, SchemasTags$zodSchema } from "./schemastags.js";
16
17
  /**
17
18
  * Format of the source document (HTML, DOCX, PPTX or PDF).
18
19
  */
20
+ export const ArticleAISearchResultDocType = {
21
+ Html: "HTML",
22
+ Docx: "DOCX",
23
+ Pdf: "PDF",
24
+ Pptx: "PPTX",
25
+ } as const;
26
+ /**
27
+ * Format of the source document (HTML, DOCX, PPTX or PDF).
28
+ */
29
+ export type ArticleAISearchResultDocType = ClosedEnum<
30
+ typeof ArticleAISearchResultDocType
31
+ >;
32
+
19
33
  export const ArticleAISearchResultDocType$zodSchema = z.enum([
20
34
  "HTML",
21
35
  "DOCX",
@@ -23,25 +37,41 @@ export const ArticleAISearchResultDocType$zodSchema = z.enum([
23
37
  "PPTX",
24
38
  ]).describe("Format of the source document (HTML, DOCX, PPTX or PDF).");
25
39
 
26
- export type ArticleAISearchResultDocType = z.infer<
27
- typeof ArticleAISearchResultDocType$zodSchema
28
- >;
29
-
30
40
  /**
31
41
  * The source type.
32
42
  */
43
+ export const ArticleAISearchResultSource = {
44
+ EGainArticle: "eGain Article",
45
+ EGainAttachment: "eGain Attachment",
46
+ } as const;
47
+ /**
48
+ * The source type.
49
+ */
50
+ export type ArticleAISearchResultSource = ClosedEnum<
51
+ typeof ArticleAISearchResultSource
52
+ >;
53
+
33
54
  export const ArticleAISearchResultSource$zodSchema = z.enum([
34
55
  "eGain Article",
35
56
  "eGain Attachment",
36
57
  ]).describe("The source type.");
37
58
 
38
- export type ArticleAISearchResultSource = z.infer<
39
- typeof ArticleAISearchResultSource$zodSchema
40
- >;
41
-
42
59
  /**
43
60
  * The custom attribute's type.
44
61
  */
62
+ export const ArticleAISearchResultType = {
63
+ String: "STRING",
64
+ Integer: "INTEGER",
65
+ Boolean: "BOOLEAN",
66
+ Datetime: "DATETIME",
67
+ } as const;
68
+ /**
69
+ * The custom attribute's type.
70
+ */
71
+ export type ArticleAISearchResultType = ClosedEnum<
72
+ typeof ArticleAISearchResultType
73
+ >;
74
+
45
75
  export const ArticleAISearchResultType$zodSchema = z.enum([
46
76
  "STRING",
47
77
  "INTEGER",
@@ -49,10 +79,6 @@ export const ArticleAISearchResultType$zodSchema = z.enum([
49
79
  "DATETIME",
50
80
  ]).describe("The custom attribute's type.");
51
81
 
52
- export type ArticleAISearchResultType = z.infer<
53
- typeof ArticleAISearchResultType$zodSchema
54
- >;
55
-
56
82
  export type ArticleAISearchResultCustomAttribute = {
57
83
  name?: string | undefined;
58
84
  value?: Array<string> | undefined;
@@ -60,9 +86,7 @@ export type ArticleAISearchResultCustomAttribute = {
60
86
  };
61
87
 
62
88
  export const ArticleAISearchResultCustomAttribute$zodSchema: z.ZodType<
63
- ArticleAISearchResultCustomAttribute,
64
- z.ZodTypeDef,
65
- unknown
89
+ ArticleAISearchResultCustomAttribute
66
90
  > = z.object({
67
91
  name: z.string().optional(),
68
92
  type: ArticleAISearchResultType$zodSchema.optional(),
@@ -77,14 +101,11 @@ export type ArticleTypeAttributes = {
77
101
  articleTypeId?: any | undefined;
78
102
  };
79
103
 
80
- export const ArticleTypeAttributes$zodSchema: z.ZodType<
81
- ArticleTypeAttributes,
82
- z.ZodTypeDef,
83
- unknown
84
- > = z.object({
85
- articleTypeId: z.any().optional(),
86
- typeName: z.string().optional(),
87
- }).describe("The type of the Article and its attributes.");
104
+ export const ArticleTypeAttributes$zodSchema: z.ZodType<ArticleTypeAttributes> =
105
+ z.object({
106
+ articleTypeId: z.any().optional(),
107
+ typeName: z.string().optional(),
108
+ }).describe("The type of the Article and its attributes.");
88
109
 
89
110
  /**
90
111
  * Represents a single document or snippet returned by search, along with its metadata and relevance score.
@@ -110,32 +131,29 @@ export type ArticleAISearchResult = {
110
131
  normalizedScore?: number | undefined;
111
132
  };
112
133
 
113
- export const ArticleAISearchResult$zodSchema: z.ZodType<
114
- ArticleAISearchResult,
115
- z.ZodTypeDef,
116
- unknown
117
- > = z.object({
118
- additionalSnippetCount: z.number().int().optional(),
119
- additionalSnippets: z.array(AdditionalSnippets$zodSchema).optional(),
120
- articleTypeAttributes: z.lazy(() => ArticleTypeAttributes$zodSchema)
121
- .optional(),
122
- contextualSummary: z.string().optional(),
123
- customAttributes: z.array(
124
- z.lazy(() => ArticleAISearchResultCustomAttribute$zodSchema),
125
- ).optional(),
126
- docName: z.string().optional(),
127
- docType: ArticleAISearchResultDocType$zodSchema,
128
- headerPath: z.string().optional(),
129
- id: z.string(),
130
- keywordSnippet: z.string().optional(),
131
- modifiedDate: z.string().optional(),
132
- name: z.string(),
133
- normalizedScore: z.number().optional(),
134
- relevanceScore: z.number().optional(),
135
- snippet: z.string(),
136
- source: ArticleAISearchResultSource$zodSchema,
137
- tagCategories: z.array(SchemasTags$zodSchema).optional(),
138
- topicBreadcrumb: z.array(AITopicBreadcrumb$zodSchema),
139
- }).describe(
140
- "Represents a single document or snippet returned by search, along with its metadata and relevance score.",
141
- );
134
+ export const ArticleAISearchResult$zodSchema: z.ZodType<ArticleAISearchResult> =
135
+ z.object({
136
+ additionalSnippetCount: z.int().optional(),
137
+ additionalSnippets: z.array(AdditionalSnippets$zodSchema).optional(),
138
+ articleTypeAttributes: z.lazy(() => ArticleTypeAttributes$zodSchema)
139
+ .optional(),
140
+ contextualSummary: z.string().optional(),
141
+ customAttributes: z.array(
142
+ z.lazy(() => ArticleAISearchResultCustomAttribute$zodSchema),
143
+ ).optional(),
144
+ docName: z.string().optional(),
145
+ docType: ArticleAISearchResultDocType$zodSchema,
146
+ headerPath: z.string().optional(),
147
+ id: z.string(),
148
+ keywordSnippet: z.string().optional(),
149
+ modifiedDate: z.string().optional(),
150
+ name: z.string(),
151
+ normalizedScore: z.number().optional(),
152
+ relevanceScore: z.number().optional(),
153
+ snippet: z.string(),
154
+ source: ArticleAISearchResultSource$zodSchema,
155
+ tagCategories: z.array(SchemasTags$zodSchema).optional(),
156
+ topicBreadcrumb: z.array(AITopicBreadcrumb$zodSchema),
157
+ }).describe(
158
+ "Represents a single document or snippet returned by search, along with its metadata and relevance score.",
159
+ );
@@ -3,20 +3,26 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
6
7
  import { Link, Link$zodSchema } from "./link.js";
7
8
 
8
9
  /**
9
10
  * The type of attachment.
10
11
  */
12
+ export const ArticleAttachmentType = {
13
+ Internal: "INTERNAL",
14
+ External: "EXTERNAL",
15
+ } as const;
16
+ /**
17
+ * The type of attachment.
18
+ */
19
+ export type ArticleAttachmentType = ClosedEnum<typeof ArticleAttachmentType>;
20
+
11
21
  export const ArticleAttachmentType$zodSchema = z.enum([
12
22
  "INTERNAL",
13
23
  "EXTERNAL",
14
24
  ]).describe("The type of attachment.");
15
25
 
16
- export type ArticleAttachmentType = z.infer<
17
- typeof ArticleAttachmentType$zodSchema
18
- >;
19
-
20
26
  export type ArticleAttachment = {
21
27
  id?: string | undefined;
22
28
  name?: string | undefined;
@@ -25,14 +31,11 @@ export type ArticleAttachment = {
25
31
  link?: Link | undefined;
26
32
  };
27
33
 
28
- export const ArticleAttachment$zodSchema: z.ZodType<
29
- ArticleAttachment,
30
- z.ZodTypeDef,
31
- unknown
32
- > = z.object({
33
- id: z.string().optional(),
34
- link: Link$zodSchema.optional(),
35
- name: z.string().optional(),
36
- size: z.number().int().optional(),
37
- type: ArticleAttachmentType$zodSchema.optional(),
38
- });
34
+ export const ArticleAttachment$zodSchema: z.ZodType<ArticleAttachment> = z
35
+ .object({
36
+ id: z.string().optional(),
37
+ link: Link$zodSchema.optional(),
38
+ name: z.string().optional(),
39
+ size: z.int().optional(),
40
+ type: ArticleAttachmentType$zodSchema.optional(),
41
+ });
@@ -57,11 +57,7 @@ export type ArticleResult = {
57
57
  personalization?: Personalization | undefined;
58
58
  };
59
59
 
60
- export const ArticleResult$zodSchema: z.ZodType<
61
- ArticleResult,
62
- z.ZodTypeDef,
63
- unknown
64
- > = z.object({
60
+ export const ArticleResult$zodSchema: z.ZodType<ArticleResult> = z.object({
65
61
  articleKeywords: z.string().optional(),
66
62
  articleSummary: z.string().optional(),
67
63
  articleType: ArticleType$zodSchema.optional(),
@@ -82,7 +78,7 @@ export const ArticleResult$zodSchema: z.ZodType<
82
78
  name: z.string().optional(),
83
79
  ownedBy: OwnedBy$zodSchema.optional(),
84
80
  personalization: Personalization$zodSchema.optional(),
85
- timesRated: z.number().int().optional(),
81
+ timesRated: z.int().optional(),
86
82
  topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema).optional(),
87
83
  versionId: z.string().optional(),
88
84
  workflow: Workflow$zodSchema.optional(),
@@ -0,0 +1,43 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { ClosedEnum } from "../types/enums.js";
7
+
8
+ export const ArticleResultAdditionalAttributes = {
9
+ AverageRating: "averageRating",
10
+ CustomAttributes: "customAttributes",
11
+ Description: "description",
12
+ ArticleSummary: "articleSummary",
13
+ ImageURL: "imageURL",
14
+ IsSubscribed: "isSubscribed",
15
+ TimesRated: "timesRated",
16
+ TopicBreadcrumb: "topicBreadcrumb",
17
+ OwnedBy: "ownedBy",
18
+ OwnedByUserName: "ownedBy.userName",
19
+ Workflow: "workflow",
20
+ Compliance: "compliance",
21
+ Personalization: "personalization",
22
+ All: "all",
23
+ } as const;
24
+ export type ArticleResultAdditionalAttributes = ClosedEnum<
25
+ typeof ArticleResultAdditionalAttributes
26
+ >;
27
+
28
+ export const ArticleResultAdditionalAttributes$zodSchema = z.enum([
29
+ "averageRating",
30
+ "customAttributes",
31
+ "description",
32
+ "articleSummary",
33
+ "imageURL",
34
+ "isSubscribed",
35
+ "timesRated",
36
+ "topicBreadcrumb",
37
+ "ownedBy",
38
+ "ownedBy.userName",
39
+ "workflow",
40
+ "compliance",
41
+ "personalization",
42
+ "all",
43
+ ]);