@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.
- package/README.md +20 -43
- package/bin/mcp-server.js +39534 -29516
- package/bin/mcp-server.js.map +298 -185
- package/esm/src/cloudflare-worker/cloudflare-worker.d.ts.map +1 -1
- package/esm/src/cloudflare-worker/cloudflare-worker.js +20 -9
- package/esm/src/cloudflare-worker/cloudflare-worker.js.map +1 -1
- package/esm/src/funcs/aiSearch.d.ts +63 -0
- package/esm/src/funcs/aiSearch.d.ts.map +1 -0
- package/esm/src/funcs/aiSearch.js +151 -0
- package/esm/src/funcs/aiSearch.js.map +1 -0
- package/esm/src/funcs/getAnnouncementArticles.d.ts +61 -0
- package/esm/src/funcs/getAnnouncementArticles.d.ts.map +1 -0
- package/esm/src/funcs/getAnnouncementArticles.js +152 -0
- package/esm/src/funcs/getAnnouncementArticles.js.map +1 -0
- package/esm/src/funcs/getAnnouncements.d.ts +39 -1
- package/esm/src/funcs/getAnnouncements.d.ts.map +1 -1
- package/esm/src/funcs/getAnnouncements.js +39 -1
- package/esm/src/funcs/getAnnouncements.js.map +1 -1
- package/esm/src/funcs/getArticle.d.ts +42 -0
- package/esm/src/funcs/getArticle.d.ts.map +1 -1
- package/esm/src/funcs/getArticle.js +42 -0
- package/esm/src/funcs/getArticle.js.map +1 -1
- package/esm/src/funcs/getArticleById.d.ts +70 -0
- package/esm/src/funcs/getArticleById.d.ts.map +1 -0
- package/esm/src/funcs/getArticleById.js +163 -0
- package/esm/src/funcs/getArticleById.js.map +1 -0
- package/esm/src/funcs/getBestAnswer.d.ts +66 -0
- package/esm/src/funcs/getBestAnswer.d.ts.map +1 -0
- package/esm/src/funcs/getBestAnswer.js +148 -0
- package/esm/src/funcs/getBestAnswer.js.map +1 -0
- package/esm/src/funcs/getMyPortals.d.ts +97 -0
- package/esm/src/funcs/getMyPortals.d.ts.map +1 -0
- package/esm/src/funcs/getMyPortals.js +180 -0
- package/esm/src/funcs/getMyPortals.js.map +1 -0
- package/esm/src/funcs/getPopularArticles.d.ts +39 -0
- package/esm/src/funcs/getPopularArticles.d.ts.map +1 -1
- package/esm/src/funcs/getPopularArticles.js +47 -3
- package/esm/src/funcs/getPopularArticles.js.map +1 -1
- package/esm/src/funcs/getPortals.d.ts +26 -1
- package/esm/src/funcs/getPortals.d.ts.map +1 -1
- package/esm/src/funcs/getPortals.js +35 -10
- package/esm/src/funcs/getPortals.js.map +1 -1
- package/esm/src/funcs/makeSuggestion.d.ts +46 -2
- package/esm/src/funcs/makeSuggestion.d.ts.map +1 -1
- package/esm/src/funcs/makeSuggestion.js +51 -3
- package/esm/src/funcs/makeSuggestion.js.map +1 -1
- package/esm/src/funcs/queryAnswers.d.ts +41 -5
- package/esm/src/funcs/queryAnswers.d.ts.map +1 -1
- package/esm/src/funcs/queryAnswers.js +41 -5
- package/esm/src/funcs/queryAnswers.js.map +1 -1
- package/esm/src/funcs/queryRetrieve.d.ts +41 -1
- package/esm/src/funcs/queryRetrieve.d.ts.map +1 -1
- package/esm/src/funcs/queryRetrieve.js +41 -1
- package/esm/src/funcs/queryRetrieve.js.map +1 -1
- package/esm/src/funcs/querySearch.d.ts +48 -1
- package/esm/src/funcs/querySearch.d.ts.map +1 -1
- package/esm/src/funcs/querySearch.js +48 -1
- package/esm/src/funcs/querySearch.js.map +1 -1
- package/esm/src/funcs/retrieveChunks.d.ts +41 -7
- package/esm/src/funcs/retrieveChunks.d.ts.map +1 -1
- package/esm/src/funcs/retrieveChunks.js +45 -19
- package/esm/src/funcs/retrieveChunks.js.map +1 -1
- package/esm/src/hooks/auth-hook.d.ts +1 -2
- package/esm/src/hooks/auth-hook.d.ts.map +1 -1
- package/esm/src/hooks/auth-hook.js +1 -65
- package/esm/src/hooks/auth-hook.js.map +1 -1
- package/esm/src/hooks/registration.d.ts.map +1 -1
- package/esm/src/hooks/registration.js +2 -16
- package/esm/src/hooks/registration.js.map +1 -1
- package/esm/src/landing-page.d.ts +5 -0
- package/esm/src/landing-page.d.ts.map +1 -0
- package/esm/src/landing-page.js +1070 -0
- package/esm/src/landing-page.js.map +1 -0
- package/esm/src/lib/base64.d.ts +2 -2
- package/esm/src/lib/base64.d.ts.map +1 -1
- package/esm/src/lib/base64.js +2 -2
- package/esm/src/lib/base64.js.map +1 -1
- package/esm/src/lib/config.d.ts +3 -3
- package/esm/src/lib/config.js +5 -5
- package/esm/src/lib/config.js.map +1 -1
- package/esm/src/lib/encodings.d.ts.map +1 -1
- package/esm/src/lib/encodings.js +10 -1
- package/esm/src/lib/encodings.js.map +1 -1
- package/esm/src/lib/matchers.d.ts.map +1 -1
- package/esm/src/lib/matchers.js +4 -1
- package/esm/src/lib/matchers.js.map +1 -1
- package/esm/src/lib/schemas.d.ts +4 -4
- package/esm/src/lib/schemas.d.ts.map +1 -1
- package/esm/src/lib/schemas.js +2 -2
- package/esm/src/lib/schemas.js.map +1 -1
- package/esm/src/lib/sdks.js +2 -2
- package/esm/src/lib/sdks.js.map +1 -1
- package/esm/src/lib/security.d.ts.map +1 -1
- package/esm/src/lib/security.js +18 -0
- package/esm/src/lib/security.js.map +1 -1
- package/esm/src/mcp-server/cli/start/command.d.ts.map +1 -1
- package/esm/src/mcp-server/cli/start/command.js +30 -0
- package/esm/src/mcp-server/cli/start/command.js.map +1 -1
- package/esm/src/mcp-server/cli/start/impl.d.ts +2 -7
- package/esm/src/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/esm/src/mcp-server/cli/start/impl.js +98 -22
- package/esm/src/mcp-server/cli/start/impl.js.map +1 -1
- package/esm/src/mcp-server/extensions.d.ts +4 -4
- package/esm/src/mcp-server/extensions.d.ts.map +1 -1
- package/esm/src/mcp-server/flags.d.ts +17 -0
- package/esm/src/mcp-server/flags.d.ts.map +1 -0
- package/esm/src/mcp-server/flags.js +5 -0
- package/esm/src/mcp-server/flags.js.map +1 -0
- package/esm/src/mcp-server/mcp-server.js +1 -1
- package/esm/src/mcp-server/mcp-server.js.map +1 -1
- package/esm/src/mcp-server/prompts.d.ts +4 -7
- package/esm/src/mcp-server/prompts.d.ts.map +1 -1
- package/esm/src/mcp-server/prompts.js.map +1 -1
- package/esm/src/mcp-server/server.d.ts +8 -1
- package/esm/src/mcp-server/server.d.ts.map +1 -1
- package/esm/src/mcp-server/server.js +19 -16
- package/esm/src/mcp-server/server.js.map +1 -1
- package/esm/src/mcp-server/tools/aiSearch.d.ts +7 -0
- package/esm/src/mcp-server/tools/aiSearch.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/aiSearch.js +83 -0
- package/esm/src/mcp-server/tools/aiSearch.js.map +1 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts +7 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.js +81 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.js.map +1 -0
- package/esm/src/mcp-server/tools/getAnnouncements.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getAnnouncements.js +39 -1
- package/esm/src/mcp-server/tools/getAnnouncements.js.map +1 -1
- package/esm/src/mcp-server/tools/getArticle.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getArticle.js +42 -0
- package/esm/src/mcp-server/tools/getArticle.js.map +1 -1
- package/esm/src/mcp-server/tools/getArticleById.d.ts +7 -0
- package/esm/src/mcp-server/tools/getArticleById.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getArticleById.js +90 -0
- package/esm/src/mcp-server/tools/getArticleById.js.map +1 -0
- package/esm/src/mcp-server/tools/getBestAnswer.d.ts +7 -0
- package/esm/src/mcp-server/tools/getBestAnswer.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getBestAnswer.js +85 -0
- package/esm/src/mcp-server/tools/getBestAnswer.js.map +1 -0
- package/esm/src/mcp-server/tools/getMyPortals.d.ts +7 -0
- package/esm/src/mcp-server/tools/getMyPortals.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getMyPortals.js +117 -0
- package/esm/src/mcp-server/tools/getMyPortals.js.map +1 -0
- package/esm/src/mcp-server/tools/getPopularArticles.d.ts +1 -1
- package/esm/src/mcp-server/tools/getPopularArticles.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getPopularArticles.js +40 -0
- package/esm/src/mcp-server/tools/getPopularArticles.js.map +1 -1
- package/esm/src/mcp-server/tools/getPortals.d.ts +1 -1
- package/esm/src/mcp-server/tools/getPortals.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getPortals.js +26 -1
- package/esm/src/mcp-server/tools/getPortals.js.map +1 -1
- package/esm/src/mcp-server/tools/makeSuggestion.d.ts +1 -1
- package/esm/src/mcp-server/tools/makeSuggestion.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/makeSuggestion.js +44 -0
- package/esm/src/mcp-server/tools/makeSuggestion.js.map +1 -1
- package/esm/src/mcp-server/tools/queryAnswers.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/queryAnswers.js +41 -5
- package/esm/src/mcp-server/tools/queryAnswers.js.map +1 -1
- package/esm/src/mcp-server/tools/queryRetrieve.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/queryRetrieve.js +41 -1
- package/esm/src/mcp-server/tools/queryRetrieve.js.map +1 -1
- package/esm/src/mcp-server/tools/querySearch.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/querySearch.js +48 -1
- package/esm/src/mcp-server/tools/querySearch.js.map +1 -1
- package/esm/src/mcp-server/tools/retrieveChunks.d.ts +1 -1
- package/esm/src/mcp-server/tools/retrieveChunks.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/retrieveChunks.js +41 -7
- package/esm/src/mcp-server/tools/retrieveChunks.js.map +1 -1
- package/esm/src/mcp-server/tools.d.ts +14 -4
- package/esm/src/mcp-server/tools.d.ts.map +1 -1
- package/esm/src/mcp-server/tools.js +203 -5
- package/esm/src/mcp-server/tools.js.map +1 -1
- package/esm/src/models/acceptlanguage.d.ts +36 -5
- package/esm/src/models/acceptlanguage.d.ts.map +1 -1
- package/esm/src/models/acceptlanguage.js +18 -4
- package/esm/src/models/acceptlanguage.js.map +1 -1
- package/esm/src/models/accessibleportal.d.ts +1 -1
- package/esm/src/models/accessibleportal.d.ts.map +1 -1
- package/esm/src/models/accessibleportal.js.map +1 -1
- package/esm/src/models/additionalsnippets.d.ts +18 -3
- package/esm/src/models/additionalsnippets.d.ts.map +1 -1
- package/esm/src/models/additionalsnippets.js +8 -1
- package/esm/src/models/additionalsnippets.js.map +1 -1
- package/esm/src/models/aisearchop.d.ts +4 -10
- package/esm/src/models/aisearchop.d.ts.map +1 -1
- package/esm/src/models/aisearchop.js +9 -20
- package/esm/src/models/aisearchop.js.map +1 -1
- package/esm/src/models/aisearchresponse.d.ts +2 -2
- package/esm/src/models/aisearchresponse.d.ts.map +1 -1
- package/esm/src/models/aisearchresponse.js.map +1 -1
- package/esm/src/models/aispaginationinfo.d.ts +1 -1
- package/esm/src/models/aispaginationinfo.d.ts.map +1 -1
- package/esm/src/models/aispaginationinfo.js +5 -4
- package/esm/src/models/aispaginationinfo.js.map +1 -1
- package/esm/src/models/aitopicbreadcrumb.d.ts +1 -1
- package/esm/src/models/aitopicbreadcrumb.d.ts.map +1 -1
- package/esm/src/models/aitopicbreadcrumb.js +2 -1
- package/esm/src/models/aitopicbreadcrumb.js.map +1 -1
- package/esm/src/models/aitopicsummary.d.ts +1 -1
- package/esm/src/models/aitopicsummary.d.ts.map +1 -1
- package/esm/src/models/aitopicsummary.js.map +1 -1
- package/esm/src/models/allaccessibleportals.d.ts +1 -1
- package/esm/src/models/allaccessibleportals.d.ts.map +1 -1
- package/esm/src/models/allaccessibleportals.js +2 -1
- package/esm/src/models/allaccessibleportals.js.map +1 -1
- package/esm/src/models/answersrequest.d.ts +16 -25
- package/esm/src/models/answersrequest.d.ts.map +1 -1
- package/esm/src/models/answersrequest.js +11 -25
- package/esm/src/models/answersrequest.js.map +1 -1
- package/esm/src/models/answersresponse.d.ts +28 -7
- package/esm/src/models/answersresponse.d.ts.map +1 -1
- package/esm/src/models/answersresponse.js +8 -0
- package/esm/src/models/answersresponse.js.map +1 -1
- package/esm/src/models/article.d.ts +2 -2
- package/esm/src/models/article.d.ts.map +1 -1
- package/esm/src/models/article.js +3 -4
- package/esm/src/models/article.js.map +1 -1
- package/esm/src/models/articleadditionalattributes.d.ts +36 -2
- package/esm/src/models/articleadditionalattributes.d.ts.map +1 -1
- package/esm/src/models/articleadditionalattributes.js +17 -0
- package/esm/src/models/articleadditionalattributes.js.map +1 -1
- package/esm/src/models/articleaisearchresult.d.ts +48 -9
- package/esm/src/models/articleaisearchresult.d.ts.map +1 -1
- package/esm/src/models/articleaisearchresult.js +17 -1
- package/esm/src/models/articleaisearchresult.js.map +1 -1
- package/esm/src/models/articleattachment.d.ts +14 -3
- package/esm/src/models/articleattachment.d.ts.map +1 -1
- package/esm/src/models/articleattachment.js +7 -2
- package/esm/src/models/articleattachment.js.map +1 -1
- package/esm/src/models/articleresult.d.ts +1 -1
- package/esm/src/models/articleresult.d.ts.map +1 -1
- package/esm/src/models/articleresult.js +1 -1
- package/esm/src/models/articleresult.js.map +1 -1
- package/esm/src/models/articleresultadditionalattributes.d.ts +34 -2
- package/esm/src/models/articleresultadditionalattributes.d.ts.map +1 -1
- package/esm/src/models/articleresultadditionalattributes.js +16 -0
- package/esm/src/models/articleresultadditionalattributes.js.map +1 -1
- package/esm/src/models/articleresults.d.ts +1 -1
- package/esm/src/models/articleresults.d.ts.map +1 -1
- package/esm/src/models/articleresults.js.map +1 -1
- package/esm/src/models/articletype.d.ts +2 -7
- package/esm/src/models/articletype.d.ts.map +1 -1
- package/esm/src/models/articletype.js +2 -16
- package/esm/src/models/articletype.js.map +1 -1
- package/esm/src/models/attachmentforcreatesuggestion.d.ts +1 -1
- package/esm/src/models/attachmentforcreatesuggestion.d.ts.map +1 -1
- package/esm/src/models/attachmentforcreatesuggestion.js.map +1 -1
- package/esm/src/models/bookmarkstatus.d.ts +1 -1
- package/esm/src/models/bookmarkstatus.d.ts.map +1 -1
- package/esm/src/models/bookmarkstatus.js +1 -1
- package/esm/src/models/bookmarkstatus.js.map +1 -1
- package/esm/src/models/complianceforarticle.d.ts +3 -3
- package/esm/src/models/complianceforarticle.d.ts.map +1 -1
- package/esm/src/models/complianceforarticle.js +8 -5
- package/esm/src/models/complianceforarticle.js.map +1 -1
- package/esm/src/models/createdby.d.ts +1 -1
- package/esm/src/models/createdby.d.ts.map +1 -1
- package/esm/src/models/createdby.js.map +1 -1
- package/esm/src/models/createsuggestion.d.ts +69 -6
- package/esm/src/models/createsuggestion.d.ts.map +1 -1
- package/esm/src/models/createsuggestion.js +31 -2
- package/esm/src/models/createsuggestion.js.map +1 -1
- package/esm/src/models/customattribute.d.ts +18 -3
- package/esm/src/models/customattribute.d.ts.map +1 -1
- package/esm/src/models/customattribute.js +6 -0
- package/esm/src/models/customattribute.js.map +1 -1
- package/esm/src/models/department.d.ts +1 -1
- package/esm/src/models/department.d.ts.map +1 -1
- package/esm/src/models/department.js.map +1 -1
- package/esm/src/models/edition.d.ts +2 -2
- package/esm/src/models/edition.d.ts.map +1 -1
- package/esm/src/models/edition.js +1 -2
- package/esm/src/models/edition.js.map +1 -1
- package/esm/src/models/errors/sdkvalidationerror.d.ts +1 -1
- package/esm/src/models/errors/sdkvalidationerror.d.ts.map +1 -1
- package/esm/src/models/errors/sdkvalidationerror.js +2 -49
- package/esm/src/models/errors/sdkvalidationerror.js.map +1 -1
- package/esm/src/models/folderbreadcrumb.d.ts +1 -1
- package/esm/src/models/folderbreadcrumb.d.ts.map +1 -1
- package/esm/src/models/folderbreadcrumb.js.map +1 -1
- package/esm/src/models/foldersummary.d.ts +1 -1
- package/esm/src/models/foldersummary.d.ts.map +1 -1
- package/esm/src/models/foldersummary.js +1 -1
- package/esm/src/models/foldersummary.js.map +1 -1
- package/esm/src/models/getannouncementarticlesop.d.ts +8 -9
- package/esm/src/models/getannouncementarticlesop.d.ts.map +1 -1
- package/esm/src/models/getannouncementarticlesop.js +12 -10
- package/esm/src/models/getannouncementarticlesop.js.map +1 -1
- package/esm/src/models/getarticlebyidop.d.ts +77 -11
- package/esm/src/models/getarticlebyidop.d.ts.map +1 -1
- package/esm/src/models/getarticlebyidop.js +31 -62
- package/esm/src/models/getarticlebyidop.js.map +1 -1
- package/esm/src/models/getbestanswerop.d.ts +1 -9
- package/esm/src/models/getbestanswerop.d.ts.map +1 -1
- package/esm/src/models/getbestanswerop.js +3 -16
- package/esm/src/models/getbestanswerop.js.map +1 -1
- package/esm/src/models/getmyportalsop.d.ts +4 -10
- package/esm/src/models/getmyportalsop.d.ts.map +1 -1
- package/esm/src/models/getmyportalsop.js +9 -10
- package/esm/src/models/getmyportalsop.js.map +1 -1
- package/esm/src/models/getpopulararticlesop.d.ts +8 -9
- package/esm/src/models/getpopulararticlesop.d.ts.map +1 -1
- package/esm/src/models/getpopulararticlesop.js +12 -10
- package/esm/src/models/getpopulararticlesop.js.map +1 -1
- package/esm/src/models/l10nstring.d.ts +1 -1
- package/esm/src/models/l10nstring.d.ts.map +1 -1
- package/esm/src/models/l10nstring.js.map +1 -1
- package/esm/src/models/languagecode.d.ts +69 -2
- package/esm/src/models/languagecode.d.ts.map +1 -1
- package/esm/src/models/languagecode.js +32 -0
- package/esm/src/models/languagecode.js.map +1 -1
- package/esm/src/models/languagecodeparameter.d.ts +90 -5
- package/esm/src/models/languagecodeparameter.d.ts.map +1 -1
- package/esm/src/models/languagecodeparameter.js +45 -4
- package/esm/src/models/languagecodeparameter.js.map +1 -1
- package/esm/src/models/languagequeryparameter.d.ts +90 -5
- package/esm/src/models/languagequeryparameter.d.ts.map +1 -1
- package/esm/src/models/languagequeryparameter.js +45 -4
- package/esm/src/models/languagequeryparameter.js.map +1 -1
- package/esm/src/models/link.d.ts +1 -1
- package/esm/src/models/link.d.ts.map +1 -1
- package/esm/src/models/link.js.map +1 -1
- package/esm/src/models/makesuggestionop.d.ts +4 -9
- package/esm/src/models/makesuggestionop.d.ts.map +1 -1
- package/esm/src/models/makesuggestionop.js +3 -7
- package/esm/src/models/makesuggestionop.js.map +1 -1
- package/esm/src/models/mandatorylanguagequeryparameter.d.ts +90 -5
- package/esm/src/models/mandatorylanguagequeryparameter.d.ts.map +1 -1
- package/esm/src/models/mandatorylanguagequeryparameter.js +45 -4
- package/esm/src/models/mandatorylanguagequeryparameter.js.map +1 -1
- package/esm/src/models/milestone.d.ts +1 -1
- package/esm/src/models/milestone.d.ts.map +1 -1
- package/esm/src/models/milestone.js.map +1 -1
- package/esm/src/models/milestonename.d.ts +1 -1
- package/esm/src/models/milestonename.d.ts.map +1 -1
- package/esm/src/models/milestonename.js.map +1 -1
- package/esm/src/models/modifiedby.d.ts +1 -1
- package/esm/src/models/modifiedby.d.ts.map +1 -1
- package/esm/src/models/modifiedby.js.map +1 -1
- package/esm/src/models/order.d.ts +10 -2
- package/esm/src/models/order.d.ts.map +1 -1
- package/esm/src/models/order.js +4 -0
- package/esm/src/models/order.js.map +1 -1
- package/esm/src/models/ownedby.d.ts +1 -1
- package/esm/src/models/ownedby.d.ts.map +1 -1
- package/esm/src/models/ownedby.js +1 -2
- package/esm/src/models/ownedby.js.map +1 -1
- package/esm/src/models/paginationinfo.d.ts +1 -1
- package/esm/src/models/paginationinfo.d.ts.map +1 -1
- package/esm/src/models/paginationinfo.js +3 -3
- package/esm/src/models/paginationinfo.js.map +1 -1
- package/esm/src/models/personalization.d.ts +4 -4
- package/esm/src/models/personalization.d.ts.map +1 -1
- package/esm/src/models/personalization.js +1 -2
- package/esm/src/models/personalization.js.map +1 -1
- package/esm/src/models/publishview.d.ts +2 -2
- package/esm/src/models/publishview.d.ts.map +1 -1
- package/esm/src/models/publishview.js.map +1 -1
- package/esm/src/models/referenceresponse.d.ts +30 -5
- package/esm/src/models/referenceresponse.d.ts.map +1 -1
- package/esm/src/models/referenceresponse.js +12 -1
- package/esm/src/models/referenceresponse.js.map +1 -1
- package/esm/src/models/requiredlanguagecode.d.ts +71 -2
- package/esm/src/models/requiredlanguagecode.d.ts.map +1 -1
- package/esm/src/models/requiredlanguagecode.js +33 -0
- package/esm/src/models/requiredlanguagecode.js.map +1 -1
- package/esm/src/models/retrievechunksop.d.ts +1 -9
- package/esm/src/models/retrievechunksop.d.ts.map +1 -1
- package/esm/src/models/retrievechunksop.js +1 -15
- package/esm/src/models/retrievechunksop.js.map +1 -1
- package/esm/src/models/retrieverequest.d.ts +15 -4
- package/esm/src/models/retrieverequest.d.ts.map +1 -1
- package/esm/src/models/retrieverequest.js +4 -0
- package/esm/src/models/retrieverequest.js.map +1 -1
- package/esm/src/models/retrieveresponse.d.ts +27 -8
- package/esm/src/models/retrieveresponse.d.ts.map +1 -1
- package/esm/src/models/retrieveresponse.js +8 -1
- package/esm/src/models/retrieveresponse.js.map +1 -1
- package/esm/src/models/schemaslink.d.ts +1 -1
- package/esm/src/models/schemaslink.d.ts.map +1 -1
- package/esm/src/models/schemaslink.js.map +1 -1
- package/esm/src/models/schemastags.d.ts +1 -1
- package/esm/src/models/schemastags.d.ts.map +1 -1
- package/esm/src/models/schemastags.js.map +1 -1
- package/esm/src/models/searchresult.d.ts +40 -5
- package/esm/src/models/searchresult.d.ts.map +1 -1
- package/esm/src/models/searchresult.js +19 -0
- package/esm/src/models/searchresult.js.map +1 -1
- package/esm/src/models/security.d.ts +5 -2
- package/esm/src/models/security.d.ts.map +1 -1
- package/esm/src/models/security.js +5 -3
- package/esm/src/models/security.js.map +1 -1
- package/esm/src/models/shorturl.d.ts +1 -1
- package/esm/src/models/shorturl.d.ts.map +1 -1
- package/esm/src/models/shorturl.js +1 -2
- package/esm/src/models/shorturl.js.map +1 -1
- package/esm/src/models/sortidnamedepartment.d.ts +12 -2
- package/esm/src/models/sortidnamedepartment.d.ts.map +1 -1
- package/esm/src/models/sortidnamedepartment.js +5 -0
- package/esm/src/models/sortidnamedepartment.js.map +1 -1
- package/esm/src/models/stage.d.ts +1 -1
- package/esm/src/models/stage.d.ts.map +1 -1
- package/esm/src/models/stage.js +1 -2
- package/esm/src/models/stage.js.map +1 -1
- package/esm/src/models/structuredauthoringfields.d.ts +1 -1
- package/esm/src/models/structuredauthoringfields.d.ts.map +1 -1
- package/esm/src/models/structuredauthoringfields.js.map +1 -1
- package/esm/src/models/tag.d.ts +1 -1
- package/esm/src/models/tag.d.ts.map +1 -1
- package/esm/src/models/tag.js.map +1 -1
- package/esm/src/models/tagcategory.d.ts +1 -1
- package/esm/src/models/tagcategory.d.ts.map +1 -1
- package/esm/src/models/tagcategory.js.map +1 -1
- package/esm/src/models/taggroup.d.ts +1 -1
- package/esm/src/models/taggroup.d.ts.map +1 -1
- package/esm/src/models/taggroup.js +1 -2
- package/esm/src/models/taggroup.js.map +1 -1
- package/esm/src/models/taggroups.d.ts +1 -1
- package/esm/src/models/taggroups.d.ts.map +1 -1
- package/esm/src/models/taggroups.js.map +1 -1
- package/esm/src/models/tags.d.ts +1 -1
- package/esm/src/models/tags.d.ts.map +1 -1
- package/esm/src/models/tags.js.map +1 -1
- package/esm/src/models/topicbreadcrumb.d.ts +1 -1
- package/esm/src/models/topicbreadcrumb.d.ts.map +1 -1
- package/esm/src/models/topicbreadcrumb.js.map +1 -1
- package/esm/src/models/topicsummary.d.ts +1 -1
- package/esm/src/models/topicsummary.d.ts.map +1 -1
- package/esm/src/models/topicsummary.js.map +1 -1
- package/esm/src/models/workflow.d.ts +1 -1
- package/esm/src/models/workflow.d.ts.map +1 -1
- package/esm/src/models/workflow.js +1 -2
- package/esm/src/models/workflow.js.map +1 -1
- package/esm/src/models/workflowmilestone.d.ts +12 -2
- package/esm/src/models/workflowmilestone.d.ts.map +1 -1
- package/esm/src/models/workflowmilestone.js +5 -0
- package/esm/src/models/workflowmilestone.js.map +1 -1
- package/esm/src/models/wserrorcommon.d.ts +2 -2
- package/esm/src/models/wserrorcommon.d.ts.map +1 -1
- package/esm/src/models/wserrorcommon.js +1 -2
- package/esm/src/models/wserrorcommon.js.map +1 -1
- package/esm/src/tool-names.d.ts +5 -0
- package/esm/src/tool-names.d.ts.map +1 -0
- package/esm/src/tool-names.js +36 -0
- package/esm/src/tool-names.js.map +1 -0
- package/esm/src/types/bigint.d.ts +6 -0
- package/esm/src/types/bigint.d.ts.map +1 -0
- package/esm/src/types/bigint.js +87 -0
- package/esm/src/types/bigint.js.map +1 -0
- package/esm/worker-configuration.d.ts +1 -0
- package/esm/worker-configuration.d.ts.map +1 -1
- package/manifest.json +78 -51
- package/package.json +11 -7
- package/src/cloudflare-worker/cloudflare-worker.ts +22 -9
- package/src/funcs/{querySearch.ts → aiSearch.ts} +49 -2
- package/src/funcs/{getAnnouncements.ts → getAnnouncementArticles.ts} +67 -10
- package/src/funcs/{getArticle.ts → getArticleById.ts} +58 -1
- package/src/funcs/{queryAnswers.ts → getBestAnswer.ts} +52 -14
- package/src/funcs/{getPortals.ts → getMyPortals.ts} +35 -2
- package/src/funcs/getPopularArticles.ts +68 -8
- package/src/funcs/makeSuggestion.ts +67 -9
- package/src/funcs/{queryRetrieve.ts → retrieveChunks.ts} +50 -15
- package/src/hooks/auth-hook.ts +3 -63
- package/src/hooks/registration.ts +3 -18
- package/src/landing-page.ts +1084 -0
- package/src/lib/base64.ts +2 -2
- package/src/lib/config.ts +5 -5
- package/src/lib/encodings.ts +12 -3
- package/src/lib/matchers.ts +5 -1
- package/src/lib/schemas.ts +10 -22
- package/src/lib/sdks.ts +2 -2
- package/src/lib/security.ts +21 -0
- package/src/mcp-server/cli/start/command.ts +31 -0
- package/src/mcp-server/cli/start/impl.ts +118 -31
- package/src/mcp-server/extensions.ts +6 -4
- package/src/mcp-server/flags.ts +21 -0
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/prompts.ts +9 -19
- package/src/mcp-server/server.ts +22 -16
- package/src/mcp-server/tools/aiSearch.ts +92 -0
- package/src/mcp-server/tools/getAnnouncementArticles.ts +90 -0
- package/src/mcp-server/tools/getArticleById.ts +99 -0
- package/src/mcp-server/tools/getBestAnswer.ts +94 -0
- package/src/mcp-server/tools/{getPortals.ts → getMyPortals.ts} +39 -5
- package/src/mcp-server/tools/getPopularArticles.ts +40 -0
- package/src/mcp-server/tools/makeSuggestion.ts +44 -0
- package/src/mcp-server/tools/retrieveChunks.ts +89 -0
- package/src/mcp-server/tools.ts +300 -46
- package/src/models/acceptlanguage.ts +21 -8
- package/src/models/accessibleportal.ts +9 -11
- package/src/models/additionalsnippets.ts +25 -18
- package/src/models/aisearchop.ts +14 -37
- package/src/models/aisearchresponse.ts +7 -13
- package/src/models/aispaginationinfo.ts +7 -10
- package/src/models/aitopicbreadcrumb.ts +4 -7
- package/src/models/aitopicsummary.ts +1 -5
- package/src/models/allaccessibleportals.ts +5 -8
- package/src/models/answersrequest.ts +22 -58
- package/src/models/answersresponse.ts +30 -24
- package/src/models/article.ts +39 -40
- package/src/models/articleadditionalattributes.ts +22 -4
- package/src/models/articleaisearchresult.ts +70 -52
- package/src/models/articleattachment.ts +18 -15
- package/src/models/articleresult.ts +2 -6
- package/src/models/articleresultadditionalattributes.ts +43 -0
- package/src/models/articleresults.ts +1 -5
- package/src/models/articletype.ts +4 -25
- package/src/models/attachmentforcreatesuggestion.ts +1 -3
- package/src/models/bookmarkstatus.ts +2 -6
- package/src/models/complianceforarticle.ts +13 -22
- package/src/models/createdby.ts +7 -8
- package/src/models/createsuggestion.ts +54 -31
- package/src/models/customattribute.ts +13 -7
- package/src/models/department.ts +1 -5
- package/src/models/edition.ts +8 -13
- package/src/models/errors/sdkvalidationerror.ts +2 -57
- package/src/models/folderbreadcrumb.ts +5 -7
- package/src/models/foldersummary.ts +2 -6
- package/src/models/getannouncementarticlesop.ts +34 -23
- package/src/models/getarticlebyidop.ts +91 -95
- package/src/models/getbestanswerop.ts +16 -48
- package/src/models/getmyportalsop.ts +29 -44
- package/src/models/getpopulararticlesop.ts +34 -23
- package/src/models/l10nstring.ts +1 -5
- package/src/models/languagecode.ts +38 -2
- package/src/models/languagecodeparameter.ts +48 -10
- package/src/models/languagequeryparameter.ts +48 -10
- package/src/models/link.ts +1 -1
- package/src/models/makesuggestionop.ts +20 -30
- package/src/models/mandatorylanguagequeryparameter.ts +50 -10
- package/src/models/milestone.ts +3 -4
- package/src/models/milestonename.ts +1 -5
- package/src/models/modifiedby.ts +1 -5
- package/src/models/order.ts +7 -2
- package/src/models/ownedby.ts +7 -8
- package/src/models/paginationinfo.ts +4 -8
- package/src/models/personalization.ts +6 -19
- package/src/models/publishview.ts +2 -8
- package/src/models/referenceresponse.ts +34 -20
- package/src/models/requiredlanguagecode.ts +39 -4
- package/src/models/retrievechunksop.ts +16 -48
- package/src/models/retrieverequest.ts +12 -10
- package/src/models/retrieveresponse.ts +34 -28
- package/src/models/schemaslink.ts +1 -5
- package/src/models/schemastags.ts +1 -5
- package/src/models/searchresult.ts +34 -8
- package/src/models/security.ts +14 -7
- package/src/models/shorturl.ts +6 -7
- package/src/models/sortidnamedepartment.ts +8 -4
- package/src/models/stage.ts +4 -5
- package/src/models/structuredauthoringfields.ts +1 -3
- package/src/models/tag.ts +1 -1
- package/src/models/tagcategory.ts +1 -5
- package/src/models/taggroup.ts +4 -5
- package/src/models/taggroups.ts +3 -4
- package/src/models/tags.ts +1 -1
- package/src/models/topicbreadcrumb.ts +1 -5
- package/src/models/topicsummary.ts +1 -5
- package/src/models/workflow.ts +3 -4
- package/src/models/workflowmilestone.ts +8 -2
- package/src/models/wserrorcommon.ts +5 -10
- package/src/tool-names.ts +35 -0
- package/src/types/bigint.ts +87 -0
- package/tsconfig.json +0 -1
- package/worker-configuration.d.ts +2 -2
- package/worker-configuration.ts +1 -0
- package/src/cloudflare-worker/landing-page.ts +0 -337
- package/src/hooks/portal-cache-hook.ts +0 -505
- package/src/hooks/portal-lookup-hook.ts +0 -429
- package/src/mcp-server/tools/getAnnouncements.ts +0 -53
- package/src/mcp-server/tools/getArticle.ts +0 -56
- package/src/mcp-server/tools/queryAnswers.ts +0 -57
- package/src/mcp-server/tools/queryRetrieve.ts +0 -55
- package/src/mcp-server/tools/querySearch.ts +0 -44
|
@@ -10,7 +10,54 @@ import { Result } from "../types/fp.js";
|
|
|
10
10
|
* Hybrid Search
|
|
11
11
|
*
|
|
12
12
|
* @remarks
|
|
13
|
-
*
|
|
13
|
+
* Hybrid Search
|
|
14
|
+
*
|
|
15
|
+
* ## How to Use This Tool
|
|
16
|
+
*
|
|
17
|
+
* **CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.
|
|
18
|
+
*
|
|
19
|
+
* **Parameter Format**:
|
|
20
|
+
* - Always wrap parameters in a `request` object: `{"request": {"portalID": "PZ-9999", "q": "loan information"}}`
|
|
21
|
+
* - Required parameters:
|
|
22
|
+
* - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
|
|
23
|
+
* - `q` (string) - The search query string (must be URL-escaped)
|
|
24
|
+
* - Optional parameters:
|
|
25
|
+
* - `Dollar_lang` (string, default: "en-US") - Language code
|
|
26
|
+
* - `dollarFilterUserProfileID` (string) - User profile ID filter
|
|
27
|
+
* - `dollarFilterTags` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
|
|
28
|
+
* - `dollarFilterTopicIds` (array) - Array of topic IDs to filter by
|
|
29
|
+
* - `articleCustomAdditionalAttributes` (string) - Comma-separated custom attribute names
|
|
30
|
+
* - `Dollar_pagenum` (number, default: 1) - Page number for pagination
|
|
31
|
+
* - `Dollar_pagesize` (number, default: 20) - Number of results per page
|
|
32
|
+
*
|
|
33
|
+
* **Example**: To search for "loan information" in portal "PZ-9999", call with:
|
|
34
|
+
* ```json
|
|
35
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information"}}
|
|
36
|
+
* ```
|
|
37
|
+
*
|
|
38
|
+
* **Example with optional parameters**:
|
|
39
|
+
* ```json
|
|
40
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "Dollar_pagesize": 25}}
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* **Note**: This endpoint is only available for Self Service environments.
|
|
44
|
+
*
|
|
45
|
+
* ## Displaying Results (MCP-Specific)
|
|
46
|
+
* **CRITICAL**: When this tool returns data successfully, you MUST display the search results to the user in your response. Do not silently process the data - always show the user what was returned.
|
|
47
|
+
*
|
|
48
|
+
* **What to display:**
|
|
49
|
+
* - Display all search results with article names and IDs
|
|
50
|
+
* - Show article `snippet` or `keywordSnippet` (the relevant text excerpt)
|
|
51
|
+
* - Display `normalizedScore` or `relevanceScore` to indicate relevance
|
|
52
|
+
* - Show `docType`, `source`, and `topicBreadcrumb` metadata
|
|
53
|
+
* - Display `contextualSummary` if available
|
|
54
|
+
* - Include `paginationInfo` if pagination is used
|
|
55
|
+
* - Format results in a numbered list with clear relevance indicators
|
|
56
|
+
*
|
|
57
|
+
* **Example**: "I found 10 articles matching 'loan information': 1) [Article Name] (ID: PROD-123) - [snippet] (Relevance: 0.89)..."
|
|
58
|
+
*
|
|
59
|
+
* ## Overview
|
|
60
|
+
* The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores.
|
|
14
61
|
*/
|
|
15
62
|
export declare function querySearch(client$: EgainMcpCore, request: AiSearchRequest, options?: RequestOptions): APIPromise<Result<AiSearchResponseResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
16
63
|
//# sourceMappingURL=querySearch.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"querySearch.d.ts","sourceRoot":"","sources":["../../../src/funcs/querySearch.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EAEf,wBAAwB,EAEzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC
|
|
1
|
+
{"version":3,"file":"querySearch.d.ts","sourceRoot":"","sources":["../../../src/funcs/querySearch.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EAEf,wBAAwB,EAEzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,wBAAwB,EACtB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}
|
|
@@ -13,7 +13,54 @@ import { APIPromise } from "../types/async.js";
|
|
|
13
13
|
* Hybrid Search
|
|
14
14
|
*
|
|
15
15
|
* @remarks
|
|
16
|
-
*
|
|
16
|
+
* Hybrid Search
|
|
17
|
+
*
|
|
18
|
+
* ## How to Use This Tool
|
|
19
|
+
*
|
|
20
|
+
* **CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.
|
|
21
|
+
*
|
|
22
|
+
* **Parameter Format**:
|
|
23
|
+
* - Always wrap parameters in a `request` object: `{"request": {"portalID": "PZ-9999", "q": "loan information"}}`
|
|
24
|
+
* - Required parameters:
|
|
25
|
+
* - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
|
|
26
|
+
* - `q` (string) - The search query string (must be URL-escaped)
|
|
27
|
+
* - Optional parameters:
|
|
28
|
+
* - `Dollar_lang` (string, default: "en-US") - Language code
|
|
29
|
+
* - `dollarFilterUserProfileID` (string) - User profile ID filter
|
|
30
|
+
* - `dollarFilterTags` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
|
|
31
|
+
* - `dollarFilterTopicIds` (array) - Array of topic IDs to filter by
|
|
32
|
+
* - `articleCustomAdditionalAttributes` (string) - Comma-separated custom attribute names
|
|
33
|
+
* - `Dollar_pagenum` (number, default: 1) - Page number for pagination
|
|
34
|
+
* - `Dollar_pagesize` (number, default: 20) - Number of results per page
|
|
35
|
+
*
|
|
36
|
+
* **Example**: To search for "loan information" in portal "PZ-9999", call with:
|
|
37
|
+
* ```json
|
|
38
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information"}}
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* **Example with optional parameters**:
|
|
42
|
+
* ```json
|
|
43
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "Dollar_pagesize": 25}}
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* **Note**: This endpoint is only available for Self Service environments.
|
|
47
|
+
*
|
|
48
|
+
* ## Displaying Results (MCP-Specific)
|
|
49
|
+
* **CRITICAL**: When this tool returns data successfully, you MUST display the search results to the user in your response. Do not silently process the data - always show the user what was returned.
|
|
50
|
+
*
|
|
51
|
+
* **What to display:**
|
|
52
|
+
* - Display all search results with article names and IDs
|
|
53
|
+
* - Show article `snippet` or `keywordSnippet` (the relevant text excerpt)
|
|
54
|
+
* - Display `normalizedScore` or `relevanceScore` to indicate relevance
|
|
55
|
+
* - Show `docType`, `source`, and `topicBreadcrumb` metadata
|
|
56
|
+
* - Display `contextualSummary` if available
|
|
57
|
+
* - Include `paginationInfo` if pagination is used
|
|
58
|
+
* - Format results in a numbered list with clear relevance indicators
|
|
59
|
+
*
|
|
60
|
+
* **Example**: "I found 10 articles matching 'loan information': 1) [Article Name] (ID: PROD-123) - [snippet] (Relevance: 0.89)..."
|
|
61
|
+
*
|
|
62
|
+
* ## Overview
|
|
63
|
+
* The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores.
|
|
17
64
|
*/
|
|
18
65
|
export function querySearch(client$, request, options) {
|
|
19
66
|
return new APIPromise($do(client$, request, options));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"querySearch.js","sourceRoot":"","sources":["../../../src/funcs/querySearch.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAEL,yBAAyB,EAEzB,kCAAkC,GACnC,MAAM,yBAAyB,CAAC;AAUjC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD
|
|
1
|
+
{"version":3,"file":"querySearch.js","sourceRoot":"","sources":["../../../src/funcs/querySearch.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAEL,yBAAyB,EAEzB,kCAAkC,GACnC,MAAM,yBAAyB,CAAC;AAUjC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,UAAU,WAAW,CACzB,OAAqB,EACrB,OAAwB,EACxB,OAAwB;IAaxB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,OAAO,EACP,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,OAAqB,EACrB,OAAwB,EACxB,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,MAAM,CAAC,EACnD,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC;IAEnB,MAAM,WAAW,GAAG;QAClB,QAAQ,EAAE,YAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE;YACpD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,KAAK,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAC5C,WAAW,CACZ,CAAC;IACF,MAAM,MAAM,GAAG,eAAe,CAAC;QAC7B,eAAe,EAAE,QAAQ,CAAC,gBAAgB;QAC1C,mBAAmB,EAAE,QAAQ,CAAC,oBAAoB;QAClD,wBAAwB,EAAE,QAAQ,CAAC,yBAAyB;QAC5D,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,UAAU,EAAE,QAAQ,CAAC,cAAc;QACnC,WAAW,EAAE,QAAQ,CAAC,eAAe;QACrC,mCAAmC,EACjC,QAAQ,CAAC,iCAAiC;QAC5C,GAAG,EAAE,QAAQ,CAAC,CAAC;KAChB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IACJ,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE;QACrD,WAAW,EAAE,UAAU;QACvB,YAAY,EAAE,IAAI;QAClB,gBAAgB,EAAE,eAAe;QACjC,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;eAC5B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI;YACjC,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;KACF,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;QACjD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;QACrC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;eACtD,CAAC,CAAC;KACR,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvC,OAAO;QACP,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAChC,MAAM,eAAe,GAAG;QACtB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KAChD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU7B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,kCAAkC,EAAE;QAC9C,GAAG,EAAE,kBAAkB;KACxB,CAAC,EACF,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,kCAAkC,CAAC,EAC9C,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,kCAAkC,EAAE;QACpE,GAAG,EAAE,eAAe;KACrB,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,kCAAkC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAC1E,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC"}
|
|
@@ -3,7 +3,8 @@ import { RequestOptions } from "../lib/sdks.js";
|
|
|
3
3
|
import { APIError } from "../models/errors/apierror.js";
|
|
4
4
|
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
5
5
|
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
6
|
-
import {
|
|
6
|
+
import { RetrieveChunksRequest } from "../models/retrievechunksop.js";
|
|
7
|
+
import { RetrieveResponse } from "../models/retrieveresponse.js";
|
|
7
8
|
import { APIPromise } from "../types/async.js";
|
|
8
9
|
import { Result } from "../types/fp.js";
|
|
9
10
|
/**
|
|
@@ -11,17 +12,50 @@ import { Result } from "../types/fp.js";
|
|
|
11
12
|
*
|
|
12
13
|
* @remarks
|
|
13
14
|
* Retrieve Chunks
|
|
15
|
+
* ## Overview
|
|
16
|
+
* The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.
|
|
17
|
+
* In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility.
|
|
18
|
+
* By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.
|
|
14
19
|
*
|
|
15
20
|
* ## Prerequisites
|
|
16
21
|
* - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
|
|
17
|
-
* - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "
|
|
22
|
+
* - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-1004")
|
|
18
23
|
*
|
|
19
|
-
* ##
|
|
20
|
-
*
|
|
24
|
+
* ## How to Use This Tool
|
|
25
|
+
* All inputs must be wrapped inside a request object. Provide a search query and language. Optional filters can be used to narrow results by tags, topics, or user profile.
|
|
21
26
|
*
|
|
22
|
-
*
|
|
27
|
+
* **Parameter Format**:
|
|
28
|
+
* - Always wrap parameters in a `request` object: `{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}`
|
|
29
|
+
* - Required parameters:
|
|
30
|
+
* - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
|
|
31
|
+
* - `q` (string) - The search query string
|
|
32
|
+
* - `Dollar_lang` (string) - Language code (e.g., "en-US")
|
|
33
|
+
* - Optional parameters:
|
|
34
|
+
* - `dollarFilterUserProfileID` (string) - User profile ID filter
|
|
35
|
+
* - `dollarFilterTags` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
|
|
36
|
+
* - `dollarFilterTopicIds` (array) - Array of topic IDs to filter by
|
|
37
|
+
* - `RetrieveRequest` (object) - Additional request body parameters:
|
|
38
|
+
* - `channel` (object) - Channel information (optional, recommended to omit)
|
|
39
|
+
* - `eventId` (string) - Event ID
|
|
40
|
+
* - `sessionId` (string) - Session ID
|
|
23
41
|
*
|
|
24
|
-
*
|
|
42
|
+
* **Example**: To retrieve chunks for query "loan information" from portal "PZ-9999", call with:
|
|
43
|
+
* ```json
|
|
44
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* **Example with RetrieveRequest body**:
|
|
48
|
+
* ```json
|
|
49
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "RetrieveRequest": {"eventId": "event-123", "sessionId": "session-456"}}}
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* ## Displaying Results (MCP-Specific)
|
|
53
|
+
* **CRITICAL**: When this tool returns data successfully, you MUST display the results to the user in your response. Do not silently process the data - always show the user what was returned.
|
|
54
|
+
*
|
|
55
|
+
* **What to display:**
|
|
56
|
+
* Always display results. Show each article name, article ID, snippet, and relevance score. If a certified answer is returned, display it first and list its references.
|
|
57
|
+
*
|
|
58
|
+
* **Example**: "I found 5 relevant articles about loan information: 1) [Article Name] (ID: PROD-123) - [snippet]..."
|
|
25
59
|
*/
|
|
26
|
-
export declare function retrieveChunks(client$: EgainMcpCore, request:
|
|
60
|
+
export declare function retrieveChunks(client$: EgainMcpCore, request: RetrieveChunksRequest, options?: RequestOptions): APIPromise<Result<RetrieveResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
27
61
|
//# sourceMappingURL=retrieveChunks.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retrieveChunks.d.ts","sourceRoot":"","sources":["../../../src/funcs/retrieveChunks.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,
|
|
1
|
+
{"version":3,"file":"retrieveChunks.d.ts","sourceRoot":"","sources":["../../../src/funcs/retrieveChunks.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,qBAAqB,EAEtB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,gBAAgB,EAEjB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,gBAAgB,EACd,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}
|
|
@@ -7,41 +7,69 @@ import { compactMap } from "../lib/primitives.js";
|
|
|
7
7
|
import { safeParse } from "../lib/schemas.js";
|
|
8
8
|
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
9
9
|
import { pathToFunc } from "../lib/url.js";
|
|
10
|
-
import {
|
|
10
|
+
import { RetrieveChunksRequest$zodSchema, } from "../models/retrievechunksop.js";
|
|
11
|
+
import { RetrieveResponse$zodSchema, } from "../models/retrieveresponse.js";
|
|
11
12
|
import { APIPromise } from "../types/async.js";
|
|
12
13
|
/**
|
|
13
14
|
* Retrieve Chunks
|
|
14
15
|
*
|
|
15
16
|
* @remarks
|
|
16
17
|
* Retrieve Chunks
|
|
18
|
+
* ## Overview
|
|
19
|
+
* The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.
|
|
20
|
+
* In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility.
|
|
21
|
+
* By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.
|
|
17
22
|
*
|
|
18
23
|
* ## Prerequisites
|
|
19
24
|
* - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
|
|
20
|
-
* - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "
|
|
25
|
+
* - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-1004")
|
|
21
26
|
*
|
|
22
|
-
* ##
|
|
23
|
-
*
|
|
27
|
+
* ## How to Use This Tool
|
|
28
|
+
* All inputs must be wrapped inside a request object. Provide a search query and language. Optional filters can be used to narrow results by tags, topics, or user profile.
|
|
24
29
|
*
|
|
25
|
-
*
|
|
30
|
+
* **Parameter Format**:
|
|
31
|
+
* - Always wrap parameters in a `request` object: `{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}`
|
|
32
|
+
* - Required parameters:
|
|
33
|
+
* - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
|
|
34
|
+
* - `q` (string) - The search query string
|
|
35
|
+
* - `Dollar_lang` (string) - Language code (e.g., "en-US")
|
|
36
|
+
* - Optional parameters:
|
|
37
|
+
* - `dollarFilterUserProfileID` (string) - User profile ID filter
|
|
38
|
+
* - `dollarFilterTags` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
|
|
39
|
+
* - `dollarFilterTopicIds` (array) - Array of topic IDs to filter by
|
|
40
|
+
* - `RetrieveRequest` (object) - Additional request body parameters:
|
|
41
|
+
* - `channel` (object) - Channel information (optional, recommended to omit)
|
|
42
|
+
* - `eventId` (string) - Event ID
|
|
43
|
+
* - `sessionId` (string) - Session ID
|
|
26
44
|
*
|
|
27
|
-
*
|
|
45
|
+
* **Example**: To retrieve chunks for query "loan information" from portal "PZ-9999", call with:
|
|
46
|
+
* ```json
|
|
47
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* **Example with RetrieveRequest body**:
|
|
51
|
+
* ```json
|
|
52
|
+
* {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "RetrieveRequest": {"eventId": "event-123", "sessionId": "session-456"}}}
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* ## Displaying Results (MCP-Specific)
|
|
56
|
+
* **CRITICAL**: When this tool returns data successfully, you MUST display the results to the user in your response. Do not silently process the data - always show the user what was returned.
|
|
57
|
+
*
|
|
58
|
+
* **What to display:**
|
|
59
|
+
* Always display results. Show each article name, article ID, snippet, and relevance score. If a certified answer is returned, display it first and list its references.
|
|
60
|
+
*
|
|
61
|
+
* **Example**: "I found 5 relevant articles about loan information: 1) [Article Name] (ID: PROD-123) - [snippet]..."
|
|
28
62
|
*/
|
|
29
63
|
export function retrieveChunks(client$, request, options) {
|
|
30
64
|
return new APIPromise($do(client$, request, options));
|
|
31
65
|
}
|
|
32
66
|
async function $do(client$, request, options) {
|
|
33
|
-
const parsed$ = safeParse(request, (value$) =>
|
|
67
|
+
const parsed$ = safeParse(request, (value$) => RetrieveChunksRequest$zodSchema.parse(value$), "Input validation failed");
|
|
34
68
|
if (!parsed$.ok) {
|
|
35
69
|
return [parsed$, { status: "invalid" }];
|
|
36
70
|
}
|
|
37
71
|
const payload$ = parsed$.value;
|
|
38
72
|
const body$ = encodeJSON("body", payload$.RetrieveRequest, { explode: true });
|
|
39
|
-
const baseURL$ = options?.serverURL
|
|
40
|
-
|| pathToFunc(PostPortalIDRetrieveOpServerList[0], {
|
|
41
|
-
charEncoding: "percent",
|
|
42
|
-
})({
|
|
43
|
-
API_DOMAIN: "api.egain.cloud",
|
|
44
|
-
});
|
|
45
73
|
const pathParams$ = {
|
|
46
74
|
portalID: encodeSimple("portalID", payload$.portalID, {
|
|
47
75
|
explode: false,
|
|
@@ -64,8 +92,8 @@ async function $do(client$, request, options) {
|
|
|
64
92
|
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
65
93
|
const context = {
|
|
66
94
|
options: client$._options,
|
|
67
|
-
baseURL:
|
|
68
|
-
operationID: "
|
|
95
|
+
baseURL: options?.serverURL ?? client$._baseURL ?? "",
|
|
96
|
+
operationID: "retrieveChunks",
|
|
69
97
|
oAuth2Scopes: null,
|
|
70
98
|
resolvedSecurity: requestSecurity,
|
|
71
99
|
securitySource: client$._options.security,
|
|
@@ -83,7 +111,7 @@ async function $do(client$, request, options) {
|
|
|
83
111
|
const requestRes = client$._createRequest(context, {
|
|
84
112
|
security: requestSecurity,
|
|
85
113
|
method: "POST",
|
|
86
|
-
baseURL:
|
|
114
|
+
baseURL: options?.serverURL,
|
|
87
115
|
path: path$,
|
|
88
116
|
headers: headers$,
|
|
89
117
|
query: query$,
|
|
@@ -109,9 +137,7 @@ async function $do(client$, request, options) {
|
|
|
109
137
|
const responseFields$ = {
|
|
110
138
|
HttpMeta: { Response: response, Request: req$ },
|
|
111
139
|
};
|
|
112
|
-
const [result$] = await M.match(M.json(200,
|
|
113
|
-
key: "RetrieveResponse",
|
|
114
|
-
}), M.nil(400, PostPortalIDRetrieveResponse$zodSchema), M.nil(500, PostPortalIDRetrieveResponse$zodSchema))(response, req$, { extraFields: responseFields$ });
|
|
140
|
+
const [result$] = await M.match(M.json(200, RetrieveResponse$zodSchema, { key: "RetrieveResponse" }), M.nil(400, RetrieveResponse$zodSchema), M.nil(500, RetrieveResponse$zodSchema))(response, req$, { extraFields: responseFields$ });
|
|
115
141
|
return [result$, { status: "complete", request: req$, response }];
|
|
116
142
|
}
|
|
117
143
|
//# sourceMappingURL=retrieveChunks.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retrieveChunks.js","sourceRoot":"","sources":["../../../src/funcs/retrieveChunks.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAU3C,OAAO,
|
|
1
|
+
{"version":3,"file":"retrieveChunks.js","sourceRoot":"","sources":["../../../src/funcs/retrieveChunks.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAU3C,OAAO,EAEL,+BAA+B,GAChC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAEL,0BAA0B,GAC3B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAqB,EACrB,OAA8B,EAC9B,OAAwB;IAaxB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,OAAO,EACP,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,OAAqB,EACrB,OAA8B,EAC9B,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,+BAA+B,CAAC,KAAK,CAAC,MAAM,CAAC,EACzD,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9E,MAAM,WAAW,GAAG;QAClB,QAAQ,EAAE,YAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE;YACpD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,KAAK,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAC9C,WAAW,CACZ,CAAC;IACF,MAAM,MAAM,GAAG,eAAe,CAAC;QAC7B,eAAe,EAAE,QAAQ,CAAC,gBAAgB;QAC1C,mBAAmB,EAAE,QAAQ,CAAC,oBAAoB;QAClD,wBAAwB,EAAE,QAAQ,CAAC,yBAAyB;QAC5D,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,GAAG,EAAE,QAAQ,CAAC,CAAC;KAChB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IACJ,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE;QACrD,WAAW,EAAE,gBAAgB;QAC7B,YAAY,EAAE,IAAI;QAClB,gBAAgB,EAAE,eAAe;QACjC,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;eAC5B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI;YACjC,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;KACF,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;QACjD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;QACrC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;eACtD,CAAC,CAAC;KACR,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvC,OAAO;QACP,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAChC,MAAM,eAAe,GAAG;QACtB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KAChD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU7B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,0BAA0B,EAAE,EAAE,GAAG,EAAE,kBAAkB,EAAE,CAAC,EACpE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,0BAA0B,CAAC,EACtC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,0BAA0B,CAAC,CACvC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC"}
|
|
@@ -9,7 +9,6 @@ export declare class AuthenticationHook implements SDKInitHook, BeforeRequestHoo
|
|
|
9
9
|
private authConfig;
|
|
10
10
|
private codeVerifier;
|
|
11
11
|
private codeChallenge;
|
|
12
|
-
private portalCacheHook?;
|
|
13
12
|
private configServer;
|
|
14
13
|
private detectedBrowser;
|
|
15
14
|
private authCancelled;
|
|
@@ -23,7 +22,7 @@ export declare class AuthenticationHook implements SDKInitHook, BeforeRequestHoo
|
|
|
23
22
|
* @returns Object containing code verifier and S256 code challenge
|
|
24
23
|
*/
|
|
25
24
|
private generatePKCEValues;
|
|
26
|
-
constructor(
|
|
25
|
+
constructor();
|
|
27
26
|
/**
|
|
28
27
|
* Detect the default browser on macOS or Windows
|
|
29
28
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth-hook.d.ts","sourceRoot":"","sources":["../../../src/hooks/auth-hook.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAgE9C,qBAAa,kBAAmB,YAAW,WAAW,EAAE,iBAAiB;IACvE,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"auth-hook.d.ts","sourceRoot":"","sources":["../../../src/hooks/auth-hook.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAgE9C,qBAAa,kBAAmB,YAAW,WAAW,EAAE,iBAAiB;IACvE,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,eAAe,CAA2B;IAClD,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,YAAY,CAAuB;IAG3C;;;OAGG;IACH,OAAO,CAAC,kBAAkB;;IAgC1B;;OAEG;YACW,oBAAoB;IA2BlC;;OAEG;YACW,kBAAkB;IA+EhC;;OAEG;YACW,oBAAoB;IAkFlC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAyBxB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAgB3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;OAEG;IACH,OAAO,CAAC,cAAc;IAuHtB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAqBzB;;OAEG;IACH,OAAO,CAAC,aAAa;IAgBrB;;OAEG;IACH,OAAO,CAAC,eAAe;IAgBvB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,YAAY;IAiEpB;;;OAGG;YACW,kBAAkB;YAqElB,SAAS;IAmBvB;;;;OAIG;YACW,uBAAuB;IA2BrC;;;OAGG;IACH,OAAO,CAAC,YAAY;IA8CpB,OAAO,CAAC,iBAAiB;IA6BzB;;OAEG;IACI,UAAU,IAAI,IAAI;IAwBzB;;OAEG;YACW,iBAAiB;IA4b/B;;OAEG;YACW,gBAAgB;IAwB9B;;OAEG;YACW,wBAAwB;IAyBtC;;OAEG;YACW,qBAAqB;IAwPnC;;;;OAIG;YACW,uBAAuB;IA0TrC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAWxB;;OAEG;YACW,iBAAiB;IAsPlB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAiFtC,aAAa,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IA8B9E,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU;IAiDrC,OAAO,CAAC,eAAe;CAiCxB"}
|
|
@@ -47,7 +47,6 @@ export class AuthenticationHook {
|
|
|
47
47
|
authConfig;
|
|
48
48
|
codeVerifier;
|
|
49
49
|
codeChallenge;
|
|
50
|
-
portalCacheHook; // PortalCacheHook reference
|
|
51
50
|
configServer = null; // HTTP server for configuration form
|
|
52
51
|
detectedBrowser = 'Google Chrome'; // Default fallback
|
|
53
52
|
authCancelled = false; // Track if user cancelled authentication
|
|
@@ -79,8 +78,7 @@ export class AuthenticationHook {
|
|
|
79
78
|
codeChallenge
|
|
80
79
|
};
|
|
81
80
|
}
|
|
82
|
-
constructor(
|
|
83
|
-
this.portalCacheHook = portalCacheHook;
|
|
81
|
+
constructor() {
|
|
84
82
|
this.authConfig = this.loadAuthConfig();
|
|
85
83
|
// Generate secure PKCE values instead of using hardcoded ones
|
|
86
84
|
const pkceValues = this.generatePKCEValues();
|
|
@@ -1045,18 +1043,6 @@ export class AuthenticationHook {
|
|
|
1045
1043
|
const accessToken = await this.getUserAccessToken(code);
|
|
1046
1044
|
console.error('✅ Access token received');
|
|
1047
1045
|
this.token = accessToken;
|
|
1048
|
-
// Trigger cache initialization if available
|
|
1049
|
-
if (this.portalCacheHook) {
|
|
1050
|
-
try {
|
|
1051
|
-
const fakeRequest = new Request(this.authConfig.environmentUrl, {
|
|
1052
|
-
headers: { 'Authorization': `Bearer ${accessToken}` }
|
|
1053
|
-
});
|
|
1054
|
-
await this.portalCacheHook.ensureCacheInitialized(fakeRequest);
|
|
1055
|
-
}
|
|
1056
|
-
catch (error) {
|
|
1057
|
-
// Cache init failure is non-fatal
|
|
1058
|
-
}
|
|
1059
|
-
}
|
|
1060
1046
|
console.error('🎉 Authentication complete! Stopping config server...');
|
|
1061
1047
|
// Close browser window on Windows (macOS handles this via AppleScript in monitoring)
|
|
1062
1048
|
if (process.platform === 'win32') {
|
|
@@ -1510,18 +1496,6 @@ export class AuthenticationHook {
|
|
|
1510
1496
|
// If code is 'code-received', token was already set by callback handler
|
|
1511
1497
|
if (code === 'code-received') {
|
|
1512
1498
|
// Token already set, just ensure cache is initialized
|
|
1513
|
-
if (this.portalCacheHook && this.token) {
|
|
1514
|
-
try {
|
|
1515
|
-
const fakeRequest = new Request(this.authConfig.environmentUrl, {
|
|
1516
|
-
headers: { 'Authorization': `Bearer ${this.token}` }
|
|
1517
|
-
});
|
|
1518
|
-
await this.portalCacheHook.ensureCacheInitialized(fakeRequest);
|
|
1519
|
-
console.error('✅ Cache initialization completed');
|
|
1520
|
-
}
|
|
1521
|
-
catch (error) {
|
|
1522
|
-
console.error('⚠️ Cache initialization failed:', error);
|
|
1523
|
-
}
|
|
1524
|
-
}
|
|
1525
1499
|
console.error('🎉 Authentication complete! Stopping config server...');
|
|
1526
1500
|
this.stopConfigServer();
|
|
1527
1501
|
return; // Success - exit
|
|
@@ -1530,19 +1504,6 @@ export class AuthenticationHook {
|
|
|
1530
1504
|
const accessToken = await this.getUserAccessToken(code);
|
|
1531
1505
|
console.error('✅ Access token received');
|
|
1532
1506
|
this.token = accessToken;
|
|
1533
|
-
// Trigger cache initialization if available
|
|
1534
|
-
if (this.portalCacheHook) {
|
|
1535
|
-
try {
|
|
1536
|
-
const fakeRequest = new Request(this.authConfig.environmentUrl, {
|
|
1537
|
-
headers: { 'Authorization': `Bearer ${accessToken}` }
|
|
1538
|
-
});
|
|
1539
|
-
await this.portalCacheHook.ensureCacheInitialized(fakeRequest);
|
|
1540
|
-
console.error('✅ Cache initialization completed');
|
|
1541
|
-
}
|
|
1542
|
-
catch (error) {
|
|
1543
|
-
console.error('⚠️ Cache initialization failed:', error);
|
|
1544
|
-
}
|
|
1545
|
-
}
|
|
1546
1507
|
console.error('🎉 Authentication complete! Stopping config server...');
|
|
1547
1508
|
this.stopConfigServer();
|
|
1548
1509
|
return; // Success - exit
|
|
@@ -1738,19 +1699,6 @@ export class AuthenticationHook {
|
|
|
1738
1699
|
const accessToken = await this.getUserAccessToken(code);
|
|
1739
1700
|
console.error('✅ Access token received');
|
|
1740
1701
|
this.token = accessToken;
|
|
1741
|
-
// Trigger cache initialization if available
|
|
1742
|
-
if (this.portalCacheHook) {
|
|
1743
|
-
try {
|
|
1744
|
-
const fakeRequest = new Request(this.authConfig.environmentUrl, {
|
|
1745
|
-
headers: { 'Authorization': `Bearer ${accessToken}` }
|
|
1746
|
-
});
|
|
1747
|
-
await this.portalCacheHook.ensureCacheInitialized(fakeRequest);
|
|
1748
|
-
console.error('✅ Cache initialization completed');
|
|
1749
|
-
}
|
|
1750
|
-
catch (error) {
|
|
1751
|
-
console.error('⚠️ Cache initialization failed:', error);
|
|
1752
|
-
}
|
|
1753
|
-
}
|
|
1754
1702
|
console.error('🎉 Authentication complete! Stopping config server...');
|
|
1755
1703
|
this.stopConfigServer();
|
|
1756
1704
|
return; // Success - exit the loop
|
|
@@ -2099,18 +2047,6 @@ export class AuthenticationHook {
|
|
|
2099
2047
|
if (existingToken) {
|
|
2100
2048
|
console.error('🎉 Using existing valid bearer token (lazy mode)');
|
|
2101
2049
|
this.token = existingToken;
|
|
2102
|
-
// Trigger cache initialization with existing token
|
|
2103
|
-
if (this.portalCacheHook) {
|
|
2104
|
-
try {
|
|
2105
|
-
const fakeRequest = new Request(this.authConfig.environmentUrl || 'https://api-dev9.knowledge.ai/knowledge', {
|
|
2106
|
-
headers: { 'Authorization': `Bearer ${existingToken}` }
|
|
2107
|
-
});
|
|
2108
|
-
await this.portalCacheHook.ensureCacheInitialized(fakeRequest);
|
|
2109
|
-
}
|
|
2110
|
-
catch (error) {
|
|
2111
|
-
// Cache init failure is non-fatal
|
|
2112
|
-
}
|
|
2113
|
-
}
|
|
2114
2050
|
return this.token;
|
|
2115
2051
|
}
|
|
2116
2052
|
}
|